grafana / writers-toolkit

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

Add rule to lint for use of command line prompts #716

Closed jdbaldry closed 1 month ago

jdbaldry commented 1 month ago

https://grafana.com/docs/writers-toolkit/write/style-guide/write-for-developers/#command-lines

github-actions[bot] commented 1 month ago

Readability report

File AutomatedReadability ColemanLiau FleschKincaid FleschReadingEase GunningFog LIX SMOG
docs/sources/review/test-documentation-changes/index.md $${7.02\space\color{red}(Δ+0.01)}$$ $${10.32\space\color{black}(Δ+0.00)}$$ $${8.62\space\color{black}(Δ+0.00)}$$ $${52.05\space\color{green}(Δ+0.08)}$$ $${10.52\space\color{green}(Δ-0.01)}$$ $${41.03\space\color{green}(Δ-0.07)}$$ $${11.18\space\color{black}(Δ+0.00)}$$
docs/sources/write/reuse-content/reuse-shared-content/index.md $${9.08\space\color{black}(Δ+0.00)}$$ $${11.11\space\color{black}(Δ+0.00)}$$ $${8.88\space\color{black}(Δ+0.00)}$$ $${57.52\space\color{black}(Δ+0.00)}$$ $${9.86\space\color{black}(Δ+0.00)}$$ $${44.85\space\color{black}(Δ+0.00)}$$ $${10.99\space\color{black}(Δ+0.00)}$$
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 |