Skip to content

Commit 6bc8328

Browse files
author
Christopher Tauchen
authored
Merge pull request #38834 from ctauchen/no-nested-assemblies
Added guidance to avoid nested assemblies
2 parents f074f92 + f81c83b commit 6bc8328

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,8 @@ The following examples include IDs that are unique to the "Configuring alert not
257257
== Writing assemblies
258258
An _assembly_ is a collection of modules that describes how to accomplish a user story.
259259

260+
Avoid link:https://redhat-documentation.github.io/modular-docs/#nesting-assemblies[nesting assemblies] in other assembly files. You can create more complicated document structures by modifying the link:https://github.com/openshift/openshift-docs/tree/main/_topic_maps[topic maps].
261+
260262
For more information about forming assemblies, see the
261263
link:https://redhat-documentation.github.io/modular-docs/#forming-assemblies[Red Hat modular docs reference guide] and the link:https://raw.githubusercontent.com/redhat-documentation/modular-docs/master/modular-docs-manual/files/TEMPLATE_ASSEMBLY_a-collection-of-modules.adoc[assembly template].
262264

0 commit comments

Comments
 (0)