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: add navigation guidance for CMS #407

Merged
merged 4 commits into from
Jan 2, 2024

Conversation

imatwawana
Copy link
Contributor

Adds guidance for finding draft and review entries in the CMS.

@imatwawana imatwawana added the type/docs Docs Squad label used across all Grafana Labs repos label Jan 2, 2024
@imatwawana imatwawana requested a review from Eve832 January 2, 2024 20:10
Copy link
Contributor

github-actions bot commented Jan 2, 2024

Overall readability score: 60.86 (🟢 +0)

File Readability
index.md 72.4 (🟢 +0.1)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
index.md 72.4 56.96 8.7 9.3 9.97 6.6
  🟢 +0.1 🔴 -0.2 🔴 -0.01 🟢 +0 🟢 +0.06 🟢 +0.02

Averages:

  Readability FRE GF ARI CLI DCRS
Average 60.86 47.78 9.56 11.6 12.05 7.31
  🟢 +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

@grafana grafana deleted a comment from github-actions bot Jan 2, 2024
imatwawana and others added 2 commits January 2, 2024 15:12
…/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…/index.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

LGTM!

@imatwawana imatwawana merged commit b16c46b into main Jan 2, 2024
6 checks passed
@imatwawana imatwawana deleted the ihm/020124-CMS-navigation-guidance branch January 2, 2024 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Docs Squad label used across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants