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-1115: Correct key usage in GH action #1817

Merged

Conversation

andf-viam
Copy link
Contributor

@andf-viam andf-viam commented Sep 13, 2023

Correct key usage in GH action step for upload / update.

Staging

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Sep 13, 2023
@viambot
Copy link
Member

viambot commented Sep 13, 2023

Overall readability score: 54.69 (🟢 +0)

File Readability
_index.md 60.2 (🟢 +0.73)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
_index.md 60.2 43.12 9.8 13.3 12.13 6.34
  🟢 +0.73 🟢 +0.1 🟢 +0.14 🟢 +0.1 🟢 +0.05 🟢 +0.08

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.69 46.18 10.87 13.32 11.82 7.77
  🟢 +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 Sep 13, 2023

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

Copy link
Member

@abe-winter abe-winter left a comment

Choose a reason for hiding this comment

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

lgtm

the link to 'create an organization key' doesn't work but I'm assuming that's a preview quirk

@andf-viam
Copy link
Contributor Author

Yes, a limitation with how we stage docs artifacts, apologies. Thanks much!

@andf-viam andf-viam merged commit 443ce80 into viamrobotics:main Sep 13, 2023
@andf-viam andf-viam deleted the DOCS-1115-clarify-org-api-key-upload branch September 13, 2023 19:11
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