Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-1899: Remove update from module create #2611

Merged

Conversation

andf-viam
Copy link
Contributor

Remove viam module update from the module creation workflow steps

  • Rationale: less steps better, as no use case exists for manual run of update (i.e. without upload immediately following).
    • If not, please correct!
  • Adjust CLI docs to reflect that upload automatically runs update, but retain mention there as the command still exists.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Mar 5, 2024
@viambot
Copy link
Member

viambot commented Mar 5, 2024

Overall readability score: 55.6 (🟢 +0)

File Readability
cli.md 64.8 (🟢 +0.02)
_index.md 62 (🔴 -0.91)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
cli.md 64.8 42.82 9.37 12.8 11.08 5.81
  🟢 +0.02 🟢 +0 🟢 +0.01 🟢 +0 🟢 +0 🟢 +0
_index.md 62 42.21 9.91 13 11.31 6.17
  🔴 -0.91 🔴 -0.3 🔴 -0.16 🔴 -0.2 🔴 -0.05 🔴 -0.07

Averages:

  Readability FRE GF ARI CLI DCRS
Average 55.6 47.46 10.64 13.21 12.08 7.61
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@viambot
Copy link
Member

viambot commented Mar 5, 2024

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/2611

Copy link
Collaborator

@npentrel npentrel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice change

@andf-viam
Copy link
Contributor Author

Hi @michaellee1019, quick update to remove update from the upload steps. LMK if you'd like to see any changes; thank you!

@andf-viam andf-viam requested a review from michaellee1019 March 5, 2024 18:28
@andf-viam andf-viam merged commit 52070bf into viamrobotics:main Mar 7, 2024
9 of 10 checks passed
@andf-viam andf-viam deleted the DOCS-1899-module-update-on-upload branch March 7, 2024 19:20
sguequierre pushed a commit to sguequierre/docs that referenced this pull request Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to build This pull request is marked safe to build from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants