You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modular-docs-manual/content/topics/module_guidelines-assembly.adoc
+4-6Lines changed: 4 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ Use the second level heading syntax for the Prerequisites section in the assembl
34
34
[discrete]
35
35
== Assembly modules
36
36
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:
38
38
39
39
.Level offset for module files
40
40
----
@@ -46,11 +46,9 @@ file3.adoc[leveloffset=+3]
46
46
All module and assembly titles must use the H1 heading designation, such as `= My heading`.
47
47
48
48
[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.
53
51
54
52
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.
55
53
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.
* Provide information about the next steps the user might want to take.
63
-
* This section can include text and links.
64
-
65
59
// 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.
0 commit comments