Skip to content

template-update-3 corrected typos #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emmurphy1 merged 1 commit into from
Apr 8, 2025
Merged

template-update-3 corrected typos #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions modular-docs-manual/files/TEMPLATE_ASSEMBLY_a-collection-of-modules.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ The following include statements pull in the module files that comprise the asse
Add a blank line after each 'include::' statement.
////

include::modules/TEMPLATE_CONCEPT_explaining_a_concept.adoc[leveloffset=+1]
include::TEMPLATE_CONCEPT_concept-explanation.adoc[leveloffset=+1]

include::modules/TEMPLATE_PROCEDURE_doing_one_procedure.adoc[leveloffset=+2]
include::TEMPLATE_PROCEDURE_doing-one-procedure.adoc[leveloffset=+2]

include::modules/TEMPLATE_PROCEDURE_reference-material.adoc[leveloffset=+2]
include::TEMPLATE_REFERENCE_reference-material.adoc[leveloffset=+2]

== Next steps

Expand Down
20 changes: 2 additions & 18 deletions modular-docs-manual/files/TEMPLATE_PROCEDURE_doing-one-procedure.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Write a short introductory paragraph that provides an overview of the module. Th

.Procedure
. Make each step an instruction.
. Include one imperative sentences for each step, for example:
. Include one imperative sentence for each step, for example:
.. Do this thing and then select *Next*.
.. Do this other thing, and this other thing, and then select *Next*.
. Use an unnumbered bullet (*) if the procedure includes only one step.
Expand All @@ -44,7 +44,6 @@ NOTE: You can add text, tables, code examples, images, and other items to a step
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.
////


.Verification
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.

Expand All @@ -59,23 +58,8 @@ Delete this section if it does not apply to your module. Provide the user with t
* Make each step an instruction.
* Use an unnumbered bullet (*) if the troubleshooting includes only one step.


.Next steps
* Provide a bulleted list of links that contain instructions that might be useful to the user after they complete this procedure.
* Use an unnumbered bullet (*) if the list includes only one step.

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.

* Provide an example of expected command output or a pop-up window that the user receives when the procedure is successful.
* List actions for the user to complete, such as entering a command, to determine the success or failure of the procedure.
* Make each step an instruction.
* Include one command or action per step.
* Use an unnumbered bullet (*) if the verification includes only one step.

[role="_additional-resources"]
.Next steps

* This section is optional.
* Delete this section if it does not apply to your module.
* Provide a bulleted list of links that contain instructions that might be useful to the user after they complete this procedure.
* Use an unnumbered bullet (*) if the list includes only one step.

Expand Down
2 changes: 1 addition & 1 deletion modular-docs-manual/files/TEMPLATE_REFERENCE_reference-material.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ AsciiDoc markup to consider for reference data:
.Unordered list
* 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].
* 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].
For tips, see _File names and anchors_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].

.Labeled list
Term 1:: Definition
Expand Down