Skip to content

Commit fd07540

Browse files
authored
Merge pull request #239 from emmurphy1/template-update-3
template-update-3 corrected typos
2 parents 5230880 + 7f12e9c commit fd07540

File tree

3 files changed

+6
-22
lines changed

3 files changed

+6
-22
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ The following include statements pull in the module files that comprise the asse
4949
Add a blank line after each 'include::' statement.
5050
////
5151
52-
include::modules/TEMPLATE_CONCEPT_explaining_a_concept.adoc[leveloffset=+1]
52+
include::TEMPLATE_CONCEPT_concept-explanation.adoc[leveloffset=+1]
5353
54-
include::modules/TEMPLATE_PROCEDURE_doing_one_procedure.adoc[leveloffset=+2]
54+
include::TEMPLATE_PROCEDURE_doing-one-procedure.adoc[leveloffset=+2]
5555
56-
include::modules/TEMPLATE_PROCEDURE_reference-material.adoc[leveloffset=+2]
56+
include::TEMPLATE_REFERENCE_reference-material.adoc[leveloffset=+2]
5757
5858
== Next steps
5959

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

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Write a short introductory paragraph that provides an overview of the module. Th
3333
3434
.Procedure
3535
. Make each step an instruction.
36-
. Include one imperative sentences for each step, for example:
36+
. Include one imperative sentence for each step, for example:
3737
.. Do this thing and then select *Next*.
3838
.. Do this other thing, and this other thing, and then select *Next*.
3939
. Use an unnumbered bullet (*) if the procedure includes only one step.
@@ -44,7 +44,6 @@ NOTE: You can add text, tables, code examples, images, and other items to a step
4444
Only the following block headings can be reliably mapped to DITA: Prerequisites, Procedure, Verification, Troubleshooting, Troubleshooting steps, Next steps, Next step, Additional resources. They must appear in this order and, with the exception of Additional resources, are only allowed in a procedure module. You can also use block headings in figure, table, and example titles.
4545
////
4646
47-
4847
.Verification
4948
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.
5049
@@ -59,23 +58,8 @@ Delete this section if it does not apply to your module. Provide the user with t
5958
* Make each step an instruction.
6059
* Use an unnumbered bullet (*) if the troubleshooting includes only one step.
6160
62-
6361
.Next steps
64-
* Provide a bulleted list of links that contain instructions that might be useful to the user after they complete this procedure.
65-
* Use an unnumbered bullet (*) if the list includes only one step.
66-
67-
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.
68-
69-
* Provide an example of expected command output or a pop-up window that the user receives when the procedure is successful.
70-
* List actions for the user to complete, such as entering a command, to determine the success or failure of the procedure.
71-
* Make each step an instruction.
72-
* Include one command or action per step.
73-
* Use an unnumbered bullet (*) if the verification includes only one step.
74-
75-
[role="_additional-resources"]
76-
.Next steps
77-
78-
* This section is optional.
62+
* Delete this section if it does not apply to your module.
7963
* Provide a bulleted list of links that contain instructions that might be useful to the user after they complete this procedure.
8064
* Use an unnumbered bullet (*) if the list includes only one step.
8165

modular-docs-manual/files/TEMPLATE_REFERENCE_reference-material.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ AsciiDoc markup to consider for reference data:
3232
.Unordered list
3333
* 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].
3434
* Use a consistent system for file names, IDs, and titles.
35-
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].
35+
For tips, see _File names and anchors_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
3636
3737
.Labeled list
3838
Term 1:: Definition

0 commit comments

Comments
 (0)