Skip to content

Commit 07b8164

Browse files
committed
Update the modular templates to match upstream changes:
* Remove the 'included in' headers. * Remove 'steps' in 'Verification steps'. * Add 'Additional resources' in the reference template.
1 parent dfaab3a commit 07b8164

File tree

4 files changed

+13
-17
lines changed

4 files changed

+13
-17
lines changed

templates/assembly.adoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
// This assembly is included in the following assemblies:
2-
//
3-
// <List assemblies here, each on a new line>
4-
51
////
62
Retains the context of the parent assembly if this assembly is nested within another assembly.
73
For more information about nesting assemblies, see: https://redhat-documentation.github.io/modular-docs/#nesting-assemblies

templates/concept.adoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
// Module included in the following assemblies:
2-
//
3-
// <List assemblies here, each on a new line>
4-
51
////
62
Base the file name and the ID on the module title. For example:
73
* file name: con-my-concept-module-a.adoc

templates/procedure.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
// Module included in the following assemblies:
2-
//
3-
// <List assemblies here, each on a new line>
4-
51
////
62
Base the file name and the ID on the module title. For example:
73
* file name: proc-doing-procedure-a.adoc
@@ -44,7 +40,7 @@ Write a short introductory paragraph that provides an overview of the module. Pr
4440
. Use an unnumbered bullet (*) if the procedure includes only one step.
4541
// </example>
4642

47-
.Verification steps
43+
.Verification
4844
////
4945
Delete this section if it does not apply to your module. Provide the user with verification methods for the procedure, such as expected output or commands that confirm success or failure.
5046
////

templates/reference.adoc

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
// Module included in the following assemblies:
2-
//
3-
// <List assemblies here, each on a new line>
4-
51
////
62
Base the file name and the ID on the module title. For example:
73
* file name: ref-my-reference-a.adoc
@@ -44,3 +40,15 @@ Term 2:: Definition
4440
|====
4541
// </example>
4642

43+
[role="_additional-resources"]
44+
.Additional resources
45+
////
46+
Optional. Delete if not used.
47+
////
48+
// <example>
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.
51+
* 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].
52+
* 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].
53+
// </example>
54+

0 commit comments

Comments
 (0)