Skip to content

Commit a30c43b

Browse files
committed
adding another reference to the limitation on partial includes
1 parent 23e8a47 commit a30c43b

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -382,6 +382,11 @@ When needed, use `.Prerequisites`, `.Next steps`, or `.Additional resources` syn
382382
== Writing text snippets
383383
A _text snippet_ is an optional component that lets you reuse content in multiple modules and assemblies. Text snippets are not a substitute for modules but instead are a more granular form of content reuse. While a module is content that a reader can understand on its own (like an article) or as part of a larger body of work (like an assembly), a text snippet is not self-contained and is not intended to be published or cross referenced on its own.
384384

385+
[IMPORTANT]
386+
====
387+
Only include entire snippets in an assembly or module. Including link:https://docs.asciidoctor.org/asciidoc/latest/directives/include-lines/[lines by content ranges] can lead to content errors when the included file is subsequently updated and is not permitted.
388+
====
389+
385390
In the context of modules and assemblies, text snippets do not include headings or anchor IDs. Text snippets also cannot contain xrefs. This type of component is text only. Examples include the following:
386391

387392
* Admonitions that appear in multiple modules.

0 commit comments

Comments
 (0)