What’s new
This page provides a summary of notable changes to Writers’ Toolkit guidance.
Products
LGTM+ Stack
Key Capabilities
Observability Solutions
IRM
Deploy The Stack
Open Source
Community resources
Dashboard templates
Try out and share prebuilt visualizations
Prometheus exporters
Get your metrics into Prometheus quickly
end-to-end solutions
Opinionated solutions that help you get there easier and faster
monitor infrastructure
Out-of-the-box KPIs, dashboards, and alerts for observability
visualize any data
Instantly connect all your data sources to Grafana
Learn
Stay up to date
Technical learning
Docs
Get started
Get started with Grafana
Build your first dashboard
Get started with Grafana Cloud
What's new / Release notes
Help build the future of open source observability software Open positions
Check out the open source projects we support Downloads
Deploy The Stack
end-to-end solutions
Opinionated solutions that help you get there easier and faster
visualize any data
Instantly connect all your data sources to Grafana
This page provides a summary of notable changes to Writers’ Toolkit guidance.
New guidance or change | Page |
---|---|
Updated screenshot guidelines with resolution information. | Screenshot guidelines |
New guidance or change | Page |
---|---|
Fixed the path to the section template file. | https://raw.githubusercontent.com/grafana/writers-toolkit/refs/heads/main/docs/static/templates/section-template.md |
Added topic/<TYPE> Make targets to create a topic from its template | Topic types |
Added video-embed to Shortcodes page. | Shortcodes |
Added examples to screenshot guidelines | Screenshot guidelines |
New guidance or change | Page |
---|---|
Updated the release life cycle stages labels to match those documented in Release life cycle for Grafana Labs. | Labels |
Added fixed-table shortcode that prevents column overflow by breaking content to a new line at any character, not just spaces between words | Shortcodes - Fixed-table |
Added column count parameter to the column-list shortcode that controls the number of columns in the multi-column list. | Shortcodes - Column-list |
New guidance or change | Page |
---|---|
Added drawer to UI elements and updated description and image for main menu. | UI elements list |
New guidance or change | Page |
---|---|
Added column-list shortcode that renders lists in multiple columns. | Shortcodes - Column-list |
Added guidance to use paragraphs in What’s new notes. | Guidelines for What’s new content |
Added kebab case and single pane of glass to word list. | Word list - kebab case and Word list - single pane of glass |
Added second menu icon image to UI elements list. | UI elements list |
Removed “main menu” from menu icon description in UI elements list. | UI elements list |
New guidance or change | Page |
---|---|
Added preference for end-to-end when talking about testing. | Word list |
Added preference for meta-monitoring when talking about monitoring other monitoring tools. | Word list |
Added preference for use of self-managed when talking about Grafana deployment methods. | Word list |
Added preference to use the title Best practices for best practice guidelines | Concept and Word list |
New guidance or change | Page |
---|---|
Added documentation for Grot guides. | Grot guides |
Revised Vale rule for use of exclamation marks and reduced its Vale severity from “error” to “warning”. | Grafana.Exclamation |
Added a What’s new page used to summarize notable changes. | What’s new |
Added guidance regarding dark and light mode for images. | Media guidelines |