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

Document docs/ignore shortcode #770

Merged
merged 3 commits into from
Jul 5, 2024

Conversation

jdbaldry
Copy link
Member

@jdbaldry jdbaldry commented Jul 2, 2024

No description provided.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Copy link
Contributor

github-actions bot commented Jul 2, 2024

Readability report

File AutomatedReadability ColemanLiau FleschKincaid FleschReadingEase GunningFog LIX SMOG
docs/sources/write/shortcodes/index.md $${7.32\space\color{red}(Δ+0.02)}$$ $${10.41\space\color{red}(Δ+0.05)}$$ $${8.15\space\color{black}(Δ+0.00)}$$ $${56.82\space\color{red}(Δ-0.08)}$$ $${9.62\space\color{green}(Δ-0.05)}$$ $${39.39\space\color{red}(Δ+0.05)}$$ $${10.90\space\color{green}(Δ-0.06)}$$
View metric targets
Metric Range Ideal score
AutomatedReadability 6 (very easy read) to 14 (extremely difficult read) 8 or less
ColemanLiau 6 (very easy read) to 17 (extremely difficult read) 9 or less
FleschKincaid 6 (very easy read) to 17 (extremely difficult read) 8 or less
FleschReadingEase 100 (very easy read) to 0 (extremely difficult read) 70 or more
GunningFog 6 (very easy read) to 17 (extremely difficult read) 10 or less
LIX 20 (very easy read) to 60+ (extremely difficult read) 35 or less
SMOG 6 (very easy read) to 17 (extremely difficult read) 10 or less

@jdbaldry
Copy link
Member Author

jdbaldry commented Jul 2, 2024

Converting to draft because of challenges with the docs/ignore implementation on the Killercoda side documented in grafana/killercoda#49

@jdbaldry jdbaldry marked this pull request as draft July 2, 2024 08:47
@jdbaldry jdbaldry marked this pull request as ready for review July 2, 2024 12:28
Copy link
Collaborator

@chri2547 chri2547 left a comment

Choose a reason for hiding this comment

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

a few suggestions.

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
@jdbaldry jdbaldry merged commit caeabda into main Jul 5, 2024
6 checks passed
@jdbaldry jdbaldry deleted the jdb/2024-07-document-docs-ignore-shortcode branch July 5, 2024 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants