Encourage use of paragraphs in What's new notes (#881)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
grafana · Oct 19, 2024 · e17bde7 · e17bde7
1 parent 9a7edd2
commit e17bde7
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/docs/sources/contribute/release-notes/index.md b/docs/sources/contribute/release-notes/index.md
@@ -135,7 +135,7 @@ When you're ready to add a What's new entry, complete the following steps:
          <th scope="row">BODY</th>
          <td>Include an overview of the feature and the problem it solves.</td>
          <td>
-           <p>If you want to view some best practices around what to write here, refer to <a href="#writing-guidelines-for-whats-new-content">Writing guidelines for What's new</a>.</p>
+           <p>If you want to view some best practices around what to write here, refer to <a href="#guidelines-for-whats-new-content">Guidelines for What's new content</a>.</p>
            <p>Add any images and a link to your public YouTube video here.</p>
            <p>If you need more information on adding an image, refer to <a href="https://grafana.com/docs/writers-toolkit/write/image-guidelines/">Image, diagram, and screenshot guidelines</a>.</p>
            <p>If you need to mention a feature flag, use this format: To try out Trace to profiles, enable the <code>traceToProfile</code> <a href="https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/feature-toggles/">feature toggle</a>.</p>
@@ -372,6 +372,9 @@ Follow these guidelines to ensure that your What's new or release notes content
   Describe the business value.
   Don't go into details about how the feature works, or configuration steps.
 
+  Use paragraphs and not bullet points.
+  The website summarizes content using the first two paragraphs and won't summarize bullet points.
+
   Link out to topics in the documentation that provide more detailed information or steps.
 
   **Example:**

diff --git a/docs/sources/whats-new.md b/docs/sources/whats-new.md
@@ -20,10 +20,11 @@ This page provides a summary of notable changes to Writers' Toolkit guidance.
 
 ## October 2024
 
-| New guidance or change                                      | Page                                                                                                                                                                                                  |
-| ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Added _kebab case_ and _single pane of glass_ to word list. | [Word list - kebab case](/docs/writers-toolkit/write/style-guide/word-list/#kebab-case) & [Word list - single pane of glass](/docs/writers-toolkit/write/style-guide/word-list/#single-pane-of-glass) |
-| Added second menu icon image to UI elements list.           | [UI elements list](/docs/writers-toolkit/write/style-guide/ui-elements/)                                                                                                                              |
+| New guidance or change                                      | Page                                                                                                                                                                                                    |
+| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Added guidance to use paragraphs in What's new notes.       | [Guidelines for What's new content](https://grafana.com/docs/writers-toolkit/contribute/release-notes/#guidelines-for-whats-new-content)                                                                |
+| Added _kebab case_ and _single pane of glass_ to word list. | [Word list - kebab case](/docs/writers-toolkit/write/style-guide/word-list/#kebab-case) and [Word list - single pane of glass](/docs/writers-toolkit/write/style-guide/word-list/#single-pane-of-glass) |
+| Added second menu icon image to UI elements list.           | [UI elements list](/docs/writers-toolkit/write/style-guide/ui-elements/)                                                                                                                                |
 
 ## September 2024