search

grafana / writers-toolkit

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

Use correct placeholder syntax #725

Closed jdbaldry closed 1 month ago

jdbaldry commented 1 month ago

I had misremembered the guidance in https://grafana.com/docs/writers-toolkit/write/style-guide/write-for-developers/#placeholder-variables

github-actions[bot] commented 1 month ago

Readability report

File AutomatedReadability ColemanLiau FleschKincaid FleschReadingEase GunningFog LIX SMOG
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/review/doc-validator/_index.md $${8.40\space\color{black}(Δ+0.00)}$$ $${11.54\space\color{black}(Δ+0.00)}$$ $${9.83\space\color{black}(Δ+0.00)}$$ $${45.73\space\color{black}(Δ+0.00)}$$ $${11.34\space\color{black}(Δ+0.00)}$$ $${46.30\space\color{black}(Δ+0.00)}$$ $${11.96\space\color{black}(Δ+0.00)}$$
docs/sources/review/lint-prose/index.md $${5.54\space\color{black}(Δ+0.00)}$$ $${8.75\space\color{black}(Δ+0.00)}$$ $${6.99\space\color{black}(Δ+0.00)}$$ $${62.31\space\color{black}(Δ+0.00)}$$ $${9.50\space\color{black}(Δ+0.00)}$$ $${30.83\space\color{black}(Δ+0.00)}$$ $${10.19\space\color{black}(Δ+0.00)}$$
docs/sources/review/test-documentation-changes/index.md $${7.01\space\color{black}(Δ+0.00)}$$ $${10.27\space\color{black}(Δ+0.00)}$$ $${8.61\space\color{black}(Δ+0.00)}$$ $${52.35\space\color{black}(Δ+0.00)}$$ $${10.56\space\color{black}(Δ+0.00)}$$ $${40.89\space\color{black}(Δ+0.00)}$$ $${11.21\space\color{black}(Δ+0.00)}$$
docs/sources/shared/refs-example.md $${7.67\space\color{black}(Δ+0.00)}$$ $${10.41\space\color{black}(Δ+0.00)}$$ $${8.37\space\color{black}(Δ+0.00)}$$ $${57.12\space\color{black}(Δ+0.00)}$$ $${9.15\space\color{black}(Δ+0.00)}$$ $${39.82\space\color{black}(Δ+0.00)}$$ $${11.21\space\color{black}(Δ+0.00)}$$
docs/sources/structure/topic-types/tutorial/index.md $${8.03\space\color{black}(Δ+0.00)}$$ $${10.42\space\color{black}(Δ+0.00)}$$ $${9.62\space\color{black}(Δ+0.00)}$$ $${49.87\space\color{black}(Δ+0.00)}$$ $${11.74\space\color{black}(Δ+0.00)}$$ $${41.71\space\color{black}(Δ+0.00)}$$ $${12.03\space\color{black}(Δ+0.00)}$$
docs/sources/write/links/_index.md $${5.51\space\color{black}(Δ+0.00)}$$ $${8.83\space\color{black}(Δ+0.00)}$$ $${6.85\space\color{black}(Δ+0.00)}$$ $${62.66\space\color{black}(Δ+0.00)}$$ $${8.68\space\color{black}(Δ+0.00)}$$ $${33.21\space\color{black}(Δ+0.00)}$$ $${9.90\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/tooling-and-workflows/index.md $${7.53\space\color{black}(Δ+0.00)}$$ $${9.95\space\color{black}(Δ+0.00)}$$ $${8.36\space\color{black}(Δ+0.00)}$$ $${58.34\space\color{black}(Δ+0.00)}$$ $${9.37\space\color{black}(Δ+0.00)}$$ $${35.61\space\color{black}(Δ+0.00)}$$ $${10.58\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 |