Skip to content

Document qa and qa-list shortcodes - #1478

Open
jdbaldry wants to merge 2 commits into
mainfrom
grafana-writers-toolkit-jdb/2026-08-aeo-faq
Open

Document qa and qa-list shortcodes#1478
jdbaldry wants to merge 2 commits into
mainfrom
grafana-writers-toolkit-jdb/2026-08-aeo-faq

Conversation

@jdbaldry

@jdbaldry jdbaldry commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

What

  • add documentation for the qa shortcode
  • add documentation for the qa-list shortcode
  • include usage examples and produced output snippets

Part of https://github.com/grafana/website/pull/32564

@jdbaldry jdbaldry added the type/docs Docs Squad label used across all Grafana Labs repos label Aug 3, 2026
Comment thread docs/sources/write/shortcodes/index.md Outdated
@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Readability report

File AutomatedReadability ColemanLiau FleschKincaid FleschReadingEase GunningFog LIX SMOG
docs/sources/write/shortcodes/index.md $${6.98\space\color{green}(Δ-0.02)}$$ $${10.56\space\color{red}(Δ+0.01)}$$ $${7.79\space\color{green}(Δ-0.01)}$$ $${56.48\space\color{red}(Δ-0.16)}$$ $${8.86\space\color{green}(Δ-0.01)}$$ $${38.97\space\color{red}(Δ+0.04)}$$ $${10.31\space\color{green}(Δ-0.03)}$$
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

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

💻 Deploy preview available (Document qa and qa-list shortcodes):

@jdbaldry
jdbaldry marked this pull request as ready for review August 4, 2026 08:44

@robbymilo robbymilo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we want this alphabetized?

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

jdbaldry commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator Author

Do we want this alphabetized?

Good call out, done in fefc23a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/docs Docs Squad label used across all Grafana Labs repos

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants