Skip to content

Commit d867e4f

Browse files
authored
Merge pull request #249 from redhat-documentation/assembly-next-steps-issue-248
Issue 248: Remove Next steps from the assembly guidelines and template
2 parents f8ddab4 + 18687e3 commit d867e4f

3 files changed

Lines changed: 11 additions & 13 deletions

File tree

modular-docs-manual/content/topics/module_guidelines-assembly.adoc

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Use the second level heading syntax for the Prerequisites section in the assembl
3434
[discrete]
3535
== Assembly modules
3636

37-
To include modules in an assembly, use the Asciidoc link:http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include directive]. Use any combination of concept, procedure, and reference modules that fulfills the purpose of the assembly. Use the `leveloffset` attribute to set the hierarchy of the module relative to the assembly, as shown in the following example:
37+
To include modules in an assembly, use the Asciidoc link:http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#include-files[include directive]. Use any combination of concept, procedure, and reference modules that fulfills the purpose of the assembly. Use the `leveloffset` attribute to set the hierarchy of the module relative to the assembly, as shown in the following example:
3838

3939
.Level offset for module files
4040
----
@@ -46,11 +46,9 @@ file3.adoc[leveloffset=+3]
4646
All module and assembly titles must use the H1 heading designation, such as `= My heading`.
4747

4848
[discrete]
49-
50-
51-
== Next steps and Additional resources
52-
These sections are optional. If you use both *Next steps* and *Additional resources*, list *Next steps* first. The listed resources link to other material closely related to the contents of the module, such as other documentation resources, instructional videos, or labs.
49+
== Additional resources
50+
This section is optional. The listed resources link to other material closely related to the contents of the module, such as other documentation resources, instructional videos, or labs. To ensure the content is DITA-compatible, do not use any non-link text in this section.
5351

5452
Focus on relevant resources that might interest the user. Do not list resources for completeness. If a resource applies to all of the modules in a user story, consider listing the resource in the Additional resources section of the assembly file. If you do this, consider including the resource in the procedure module as a comment.
5553

56-
NOTE: If you use *Next steps* or *Additional resources* in an assembly file, check whether the last module in the assembly also has *Next steps* or *Additional resources*. If so, view the rendered HTML and consider rewriting or reorganizing the assembly.
54+
NOTE: If you use *Additional resources* in an assembly file, check whether the last module in the assembly also has *Additional resources*. If so, view the rendered HTML and consider rewriting or reorganizing the assembly.

modular-docs-manual/content/topics/whats-new.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,24 @@ For a complete list of changes, see link:https://github.com/redhat-documentation
1111
//
1212
// * <Brief description of change. Include an inline link to the relevant section of the guide.>
1313
// link:<URL of the GitHub issue associated with this change>
14+
[discrete]
15+
== 2026: February
16+
17+
* Removed references the Next steps section from the assembly guidelines and template to avoid a confusing order in DITA.
18+
1419
[discrete]
1520
== 2025: October
21+
1622
* Removed references to the [discrete] tag for concept and reference modules.
1723
* Updated the optional sections in the Procedure module section.
1824

19-
2025
[discrete]
2126
== 2025: April
2227

2328
* Removed 'Limitations' section from the Procedure section.
2429
* Updated the comments in the templates to provide guidance to prepare for migration to DITA.
2530

31+
[discrete]
2632
== 2024: January
2733

2834
* Removed the `*[role="_abstract"]*` tag from the templates (regression).

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,6 @@ include::TEMPLATE_PROCEDURE_doing-one-procedure.adoc[leveloffset=+2]
5656
5757
include::TEMPLATE_REFERENCE_reference-material.adoc[leveloffset=+2]
5858
59-
== Next steps
60-
61-
* This section is optional.
62-
* Provide information about the next steps the user might want to take.
63-
* This section can include text and links.
64-
6559
// If the last module included in your assembly contains an Additional resources section as well, check the appearance of the rendered assembly. If the two Additional resources sections might be confusing for a reader, consider consolidating their content and removing one of them.
6660
6761
[role="_additional-resources"]

0 commit comments

Comments
 (0)