Skip to content

Commit 9da51f3

Browse files
committed
issue-126 reinstated old Additional resources examples
1 parent ca40230 commit 9da51f3

6 files changed

+29
-24
lines changed

modular-docs-manual/files/TEMPLATE_ASSEMBLY_a-collection-of-modules.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ include::modules/TEMPLATE_PROCEDURE_reference-material.adoc[leveloffset=2]
3838

3939
[role="_additional-resources"]
4040
== Additional resources (or Next steps)
41-
// An optional bulleted list of links to other material closely related to the contents of the assembly.
42-
43-
* link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]
44-
* link:https://asciidoctor.org/docs/user-manual/[Asciidoctor User Manual]
41+
//Optional
42+
* A bulleted list of links to other material closely related to the contents of the assembly, including xref links to other assemblies in your collection.
43+
* For more details on writing assemblies, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
44+
* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
4545

4646
// Restore the context to what it was before this assembly.
4747
ifdef::parent-context[:context: {parent-context}]

modular-docs-manual/files/TEMPLATE_CONCEPT_concept-explanation.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ The contents of a concept module give the user descriptions and explanations nee
2626

2727
[role="_additional-resources"]
2828
.Additional resources
29-
// An optional bulleted list of links to other material closely related to the contents of the concept module.
30-
31-
* link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]
32-
* link:https://asciidoctor.org/docs/user-manual/[Asciidoctor User Manual]
29+
//Optional
30+
* A bulleted list of links to other material closely related to the contents of the concept module.
31+
* Currently, modules cannot include xrefs, so you cannot include links to other content in your collection. If you need to link to another assembly, add the xref to the assembly that includes this module.
32+
* For more details on writing concept modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
33+
* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].

modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ The `[role="_abstract"]` tag defines the first paragraph of the module for searc
4343

4444
[role="_additional-resources"]
4545
.Additional resources
46-
// An optional bulleted list of links to other material closely related to the contents of the procedure module.
47-
48-
* link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]
49-
* link:https://asciidoctor.org/docs/user-manual/[Asciidoctor User Manual]
46+
//Optional
47+
* A bulleted list of links to other material closely related to the contents of the procedure module.
48+
* Currently, modules cannot include xrefs, so you cannot include links to other content in your collection. If you need to link to another assembly, add the xref to the assembly that includes this module.
49+
* For more details on writing procedure modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
50+
* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].

modular-docs-manual/files/templates-without-comments/assembly-a-collection-of-modules.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,11 @@ include::modules/TEMPLATE_PROCEDURE_doing_one_procedure.adoc[leveloffset=+2]
2121

2222
[role="_additional-resources"]
2323
== Additional resources (or Next steps)
24-
// An optional bulleted list of links to other material closely related to the contents of the assembly.
25-
26-
* link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]
27-
* link:https://asciidoctor.org/docs/user-manual/[Asciidoctor User Manual]
24+
//Optional
25+
* A bulleted list of links to other material closely related to the contents of the assembly, including xref links to other assemblies in your collection.
26+
* For more details on writing assemblies, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
27+
* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
2828

29+
// Restore the context to what it was before this assembly.
2930
ifdef::parent-context[:context: {parent-context}]
3031
ifndef::parent-context[:!context:]

modular-docs-manual/files/templates-without-comments/con-concept-explanation.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ The contents of a concept module give the user descriptions and explanations nee
1515

1616
[role="_additional-resources"]
1717
.Additional resources
18-
// An optional bulleted list of links to other material closely related to the contents of the concept module.
19-
20-
* link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]
21-
* link:https://asciidoctor.org/docs/user-manual/[Asciidoctor User Manual]
18+
//Optional
19+
* A bulleted list of links to other material closely related to the contents of the concept module.
20+
* Currently, modules cannot include xrefs, so you cannot include links to other content in your collection. If you need to link to another assembly, add the xref to the assembly that includes this module.
21+
* For more details on writing concept modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
22+
* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].

modular-docs-manual/files/templates-without-comments/proc-doing-one-procedure.adoc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ The `[role="_abstract"]` tag defines the first paragraph of the module for searc
3232

3333
[role="_additional-resources"]
3434
.Additional resources
35-
// An optional bulleted list of links to other material closely related to the contents of the procedure module.
36-
37-
* link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide]
38-
* link:https://asciidoctor.org/docs/user-manual/[Asciidoctor User Manual]
35+
//Optional
36+
* A bulleted list of links to other material closely related to the contents of the procedure module.
37+
* Currently, modules cannot include xrefs, so you cannot include links to other content in your collection. If you need to link to another assembly, add the xref to the assembly that includes this module.
38+
* For more details on writing procedure modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
39+
* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].

0 commit comments

Comments
 (0)