What's new
Open source RSS
Last reviewed: August 27, 2024

What’s new

This page provides a summary of notable changes to Writers’ Toolkit guidance.

February 2025

New guidance or changePage
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 templateTopic types

January 2025

New guidance or changePage
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 wordsShortcodes - 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

November 2024

New guidance or changePage
Added drawer to UI elements and updated description and image for main menu.UI elements list

October 2024

New guidance or changePage
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

September 2024

New guidance or changePage
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 guidelinesConcept and Word list

August 2024

New guidance or changePage
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