You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing_to_docs/doc_guidelines.adoc
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1710,28 +1710,28 @@ The following guidelines apply to all "Additional resources" sections:
1710
1710
1711
1711
* You must include the `[role="_additional-resources"]` attribute declaration before the section heading.
1712
1712
* You must not include paragraphs in the section. Use an unordered list.
1713
-
* The links and xrefs in the unordered list must contain human-readable text between the square brackets.
1714
-
* Each item in the unordered list must contain a minimum of text besides the link or xref.
1713
+
* The links and xrefs in the unordered list must contain minimal-length, human-readable text between the square brackets. This text is often the title of the linked page.
1714
+
* You must not include text outside of the square brackets.
1715
1715
1716
1716
Additionally, in an assembly, use `==` formatting for the section heading (`== Additional resources`). Use of this heading syntax at the assembly level indicates that the sections relate to the whole assembly. For example:
Only use `.` formatting (`.Additional resources`) in a module or to follow a module in an assembly. Because you cannot use the xrefs in modules, this functions as a _trailing include_ at the assembly level, where the `.` formatting of the `include` statement indicates that the resource applies specifically to the module and not to the assembly. For example:
1728
1728
1729
1729
----
1730
1730
[role="_additional-resources"]
1731
1731
.Additional resources
1732
-
* link:some-url.com[Human readable label]
1733
-
* xref:some_xref[Human readable label]
1734
-
* xref:some_other_xref[Human readable label]
1732
+
* link:example.com[IANA example domain for documentation]
1733
+
* xref:../installation/installing-the-product.adoc#installing-the-product[Installing the product]
0 commit comments