-
Bug
-
Resolution: Unresolved
-
Critical
-
None
-
1.8.1, 1.9.0
-
None
-
False
-
-
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:
- Improved the style advice for release note texts
- Clarified guidance for the correct tenses to use in release notes
- Recommended adding headings to each release note
- Clarified advice on references to Jira in release notes
- Provided instructions for release note formatting in AsciiDoc that will simplify DITA migration
- Provided a single set of approved names for all release note types and sections
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
- 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.
- 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]