grafana / writers-toolkit

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

Fix Vale linting errors #715

Closed jdbaldry closed 4 months ago

jdbaldry commented 4 months ago

Signed-off-by: Jack Baldry jack.baldry@grafana.com

github-actions[bot] commented 4 months ago

Readability report

File AutomatedReadability ColemanLiau FleschKincaid FleschReadingEase GunningFog LIX SMOG
docs/sources/contribute/release-notes/index.md $${8.30\space\color{black}(Δ+0.00)}$$ $${9.37\space\color{black}(Δ+0.00)}$$ $${8.78\space\color{black}(Δ+0.00)}$$ $${60.98\space\color{black}(Δ+0.00)}$$ $${10.60\space\color{black}(Δ+0.00)}$$ $${37.78\space\color{black}(Δ+0.00)}$$ $${11.34\space\color{black}(Δ+0.00)}$$
docs/sources/review/backport-changes/index.md $${11.86\space\color{black}(Δ+0.00)}$$ $${10.90\space\color{black}(Δ+0.00)}$$ $${11.66\space\color{black}(Δ+0.00)}$$ $${49.98\space\color{black}(Δ+0.00)}$$ $${13.23\space\color{black}(Δ+0.00)}$$ $${51.35\space\color{black}(Δ+0.00)}$$ $${13.26\space\color{black}(Δ+0.00)}$$
docs/sources/review/cla-assistant/index.md $${8.16\space\color{black}(Δ+0.00)}$$ $${10.72\space\color{black}(Δ+0.00)}$$ $${8.85\space\color{black}(Δ+0.00)}$$ $${54.87\space\color{black}(Δ+0.00)}$$ $${10.99\space\color{black}(Δ+0.00)}$$ $${41.44\space\color{black}(Δ+0.00)}$$ $${11.67\space\color{black}(Δ+0.00)}$$
docs/sources/write/markdown-guide/index.md $${6.78\space\color{black}(Δ+0.00)}$$ $${10.37\space\color{black}(Δ+0.00)}$$ $${7.28\space\color{black}(Δ+0.00)}$$ $${59.89\space\color{black}(Δ+0.00)}$$ $${8.69\space\color{black}(Δ+0.00)}$$ $${35.85\space\color{black}(Δ+0.00)}$$ $${10.13\space\color{black}(Δ+0.00)}$$
docs/sources/write/shortcodes/index.md $${7.30\space\color{black}(Δ+0.00)}$$ $${10.36\space\color{black}(Δ+0.00)}$$ $${8.15\space\color{black}(Δ+0.00)}$$ $${56.90\space\color{black}(Δ+0.00)}$$ $${9.67\space\color{black}(Δ+0.00)}$$ $${39.34\space\color{black}(Δ+0.00)}$$ $${10.96\space\color{black}(Δ+0.00)}$$
docs/sources/write/style-guide/inclusive-writing/index.md $${6.28\space\color{black}(Δ+0.00)}$$ $${9.57\space\color{black}(Δ+0.00)}$$ $${7.67\space\color{black}(Δ+0.00)}$$ $${58.02\space\color{black}(Δ+0.00)}$$ $${9.98\space\color{black}(Δ+0.00)}$$ $${37.36\space\color{black}(Δ+0.00)}$$ $${10.76\space\color{black}(Δ+0.00)}$$
docs/sources/write/style-guide/ux-writing/index.md $${5.76\space\color{black}(Δ+0.00)}$$ $${9.25\space\color{black}(Δ+0.00)}$$ $${6.65\space\color{black}(Δ+0.00)}$$ $${63.38\space\color{black}(Δ+0.00)}$$ $${8.37\space\color{black}(Δ+0.00)}$$ $${33.65\space\color{black}(Δ+0.00)}$$ $${9.58\space\color{black}(Δ+0.00)}$$
docs/sources/write/style-guide/voice-tone-guidelines/index.md $${8.27\space\color{black}(Δ+0.00)}$$ $${10.89\space\color{black}(Δ+0.00)}$$ $${8.63\space\color{black}(Δ+0.00)}$$ $${56.36\space\color{black}(Δ+0.00)}$$ $${10.77\space\color{black}(Δ+0.00)}$$ $${39.01\space\color{black}(Δ+0.00)}$$ $${11.86\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 |