Skip to content

Commit 33ae51d

Browse files
authored
Merge pull request #65977 from jeana-redhat/doc-guide-addl-resource-examples
[no issue] Update additional resources examples and guidelines
2 parents 5e922c5 + a609aa8 commit 33ae51d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1710,28 +1710,28 @@ The following guidelines apply to all "Additional resources" sections:
17101710

17111711
* You must include the `[role="_additional-resources"]` attribute declaration before the section heading.
17121712
* 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.
17151715

17161716
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:
17171717

17181718
----
17191719
[role="_additional-resources"]
17201720
[id="additional-resources_configuring-alert-notifications"]
17211721
== Additional resources
1722-
* link:some-url.com[Human readable label]
1723-
* xref:some_xref[Human readable label]
1724-
* xref:some_other_xref[Human readable label]
1722+
* link:example.com[IANA example domain for documentation]
1723+
* xref:../installation/installing-the-product.adoc#installing-the-product[Installing the product]
1724+
* xref:../configuration/product-settings.adoc#installation-parameters_product-settings[Product installation configuration parameters]
17251725
----
17261726

17271727
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:
17281728

17291729
----
17301730
[role="_additional-resources"]
17311731
.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]
1734+
* xref:../configuration/product-settings.adoc#installation-parameters_product-settings[Product installation configuration parameters]
17351735
----
17361736

17371737
== Admonitions

0 commit comments

Comments
 (0)