Skip to content

Commit 6afe482

Browse files
committed
Update the modular templates to match upstream changes:
* Allow xrefs in modules; issue #113
1 parent 21ad3b4 commit 6afe482

File tree

4 files changed

+4
-7
lines changed

4 files changed

+4
-7
lines changed

data/templates/assembly.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Optional. Delete if not used.
7070
////
7171
7272
{% if examples -%}
73-
* 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.
73+
* A bulleted list of links to other closely-related material. These links can include `link:` and `xref:` macros.
7474
* For more details on writing assemblies, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
7575
* 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].
7676
{%- endif %}

data/templates/concept.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,7 @@ The contents of a concept module give the user descriptions and explanations nee
3434
Optional. Delete if not used.
3535
////
3636
{% if examples -%}
37-
* A bulleted list of links to other material closely related to the contents of the concept module.
38-
* 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.
37+
* A bulleted list of links to other closely-related material. These links can include `link:` and `xref:` macros.
3938
* 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].
4039
* 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].
4140
{%- endif %}

data/templates/procedure.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ Delete this section if it does not apply to your module. Provide the user with v
6060
Optional. Delete if not used.
6161
////
6262
{% if examples -%}
63-
* A bulleted list of links to other material closely related to the contents of the procedure module.
64-
* 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.
63+
* A bulleted list of links to other closely-related material. These links can include `link:` and `xref:` macros.
6564
* 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].
6665
* 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].
6766
{%- endif %}

data/templates/reference.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@ Term 2:: Definition
4646
Optional. Delete if not used.
4747
////
4848
{% if examples -%}
49-
* A bulleted list of links to other material closely related to the contents of the concept module.
50-
* 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+
* A bulleted list of links to other closely-related material. These links can include `link:` and `xref:` macros.
5150
* For more details on writing reference modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
5251
* 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].
5352
{%- endif %}

0 commit comments

Comments
 (0)