Uploaded image for project: 'Red Hat Developer Hub Bugs'
  1. Red Hat Developer Hub Bugs
  2. RHDHBUGS-2420

Use latest style guide recommendations for release notes

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Critical Critical
    • None
    • 1.8.1, 1.9.0
    • Documentation
    • None
    • False
    • Hide

      None

      Show
      None
    • False

      Description of problem:

      • Release note updates. To address commonly encountered problems with release notes, the release note improvement initiative made several additions and changes to guidance in the SSG:
      • Clarified guidance for the correct tenses to use in release notes
      • Recommended adding headings to each release note

      See https://redhat-documentation.github.io/supplementary-style-guide/#release-notes 

      See email: What's new with the Red Hat Supplementary Style Guide: Closing out 2025

      Prerequisites (if any, like setup, operators/versions):

      Steps to Reproduce

      1. For customer information, include references to Jira tickets on all Known issues and Fixed issues.   Place the reference on the line directly after the entry, not inside parenthesis or brackets.
      1. To avoid nesting headings excessively, treat each release note as a description list item.

      Example:

      Release note heading::
      This is the main release note text.
      +
      Add another list:
      
      * List item 1
      * List item 2
      
      +
      link:https://issues.redhat.com/browse/TICKET-REFERENCE[TICKET-REFERENCE]
      

       

      Actual results:

      Expected results:

      Reproducibility (Always/Intermittent/Only Once):

      Build Details:

      Additional info (Such as Logs, Screenshots, etc):

              ffloreth@redhat.com Fabrice Flore-Thébault
              ffloreth@redhat.com Fabrice Flore-Thébault
              RHDH Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: