Skip to content

Commit 7e4d390

Browse files
authored
Merge pull request #538 from jafiala/RN-format
Add RN formatting information
2 parents 5c861a3 + 1f5f309 commit 7e4d390

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

supplementary_style_guide/style_guidelines/release-notes.adoc

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,41 @@ If you refer to those tickets without including a link, inform the user. See the
7474

7575
“Some referenced tickets are not linked. This means that the ticket is not accessible without Red Hat credentials."
7676

77+
[[release-note-asciidoc-format]]
78+
== Release note formatting in AsciiDoc
79+
To avoid nesting headings excessively, treat each release note as a description list item. This format is also compatible with the AEM DITA migration.
80+
81+
.Release note AsciiDoc basic formatting template
82+
----
83+
Release note heading::
84+
This is the main release note text.
85+
+
86+
Add another paragraph if necessary.
87+
+
88+
link:https://issues.redhat.com/browse/TICKET-REFERENCE[TICKET-REFERENCE]
89+
----
90+
91+
For the DITA conversion to work correctly, the list must remain uninterrupted. Follow these guidelines:
92+
93+
* If the release note needs another paragraph or additional elements, you must attach all lines after the first line to the description with a plus sign on a separate line.
94+
* If you need to have a list inside a release note text, attach it with a plus sign on a separate line, and add an empty line followed by a plus sign after the list to attach the next paragraph, such as the ticket reference.
95+
* If you use an open block (`--`) to separate elements within the description, attach it with plus signs before and after.
96+
97+
98+
.Release note AsciiDoc complex formatting template
99+
----
100+
Release note heading::
101+
This is the main release note text.
102+
+
103+
Add another list:
104+
105+
* List item 1
106+
* List item 2
107+
108+
+
109+
link:https://issues.redhat.com/browse/TICKET-REFERENCE[TICKET-REFERENCE]
110+
----
111+
77112
[[release-note-types]]
78113
== Release note types and sections
79114

0 commit comments

Comments
 (0)