grafana / writers-toolkit

Technical documentation guidelines for Grafana Labs documentation
https://grafana.com/docs/writers-toolkit/
16 stars 12 forks source link

Document docs/ignore shortcode #770

Closed jdbaldry closed 5 days ago

github-actions[bot] commented 1 week ago

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](https://en.wikipedia.org/wiki/Automated_readability_index) | 6 (very easy read) to 14 (extremely difficult read) | 8 or less | | [ColemanLiau](https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index) | 6 (very easy read) to 17 (extremely difficult read) | 9 or less | | [FleschKincaid](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests) | 6 (very easy read) to 17 (extremely difficult read) | 8 or less | | [FleschReadingEase](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests) | 100 (very easy read) to 0 (extremely difficult read) | 70 or more | | [GunningFog](https://en.wikipedia.org/wiki/Gunning_fog_index) | 6 (very easy read) to 17 (extremely difficult read) | 10 or less | | [LIX](https://en.wikipedia.org/wiki/Lix_(readability_test)) | 20 (very easy read) to 60+ (extremely difficult read) | 35 or less | | [SMOG](https://en.wikipedia.org/wiki/SMOG) | 6 (very easy read) to 17 (extremely difficult read) | 10 or less |
jdbaldry commented 1 week ago

Converting to draft because of challenges with the docs/ignore implementation on the Killercoda side documented in https://github.com/grafana/killercoda/pull/49