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: contributing_to_docs/doc_guidelines.adoc
-50Lines changed: 0 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -419,56 +419,6 @@ When using the "Prerequisites", "Next steps", or "Additional resources" headings
419
419
Only use `.` formatting (`.Additional resources`) to follow a module in an assembly. Because you cannot use the xrefs in modules, this functions as a _trailing include_ at the assembly level, where the `.` formatting of the `include` statement indicates that the resource applies specifically to the module and not to the assembly.
420
420
====
421
421
422
-
=== Including by tags
423
-
You can use `tag` attributes to link:https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions[define regions of a file and include by tag instead of the whole file.] This enables you to make conditional modifications to existing modules instead of duplicating content. When creating a tag, use a tag name that makes it easy to understand where the content defined will be included.
424
-
425
-
* In assembly files, use the `tags` (plural) attribute when there is more than one tag specified. Use the `tag` (singular) attribute when there is only one tag. For example:
* In the module files, use `//` before the tag directives in asciidoc text and a `#` before tag directives in YAML. For example:
440
-
+
441
-
.Included file tag directives
442
-
[source,text]
443
-
----
444
-
// tag::TagName[]
445
-
== Tagging regions
446
-
447
-
Tags are useful when you want to identify specific regions of a file to include. You can then select the lines between the boundaries of the include tag/end directives to include using the tags attribute.
448
-
449
-
In the included file, the tag directives (e.g., tag::<tag_name>[] and end::<tag_name>[]) must follow a word boundary and precede a space character or the end of line. The tag name must not be empty and must consist exclusively of non-space characters.
450
-
451
-
.Example CR
452
-
[source,yaml]
453
-
--
454
-
spec:
455
-
# tag::Mode1[]
456
-
mode: openshift
457
-
# end::Mode1[]
458
-
# tag::Mode2[]
459
-
mode: openshift-network
460
-
# end::Mode2[]
461
-
--
462
-
// end::TagName[]
463
-
----
464
-
+
465
-
[WARNING]
466
-
====
467
-
The use of a wildcard (`*`) is not fully supported by PV1. Verify that access.redhat.com builds and docs.openshift.com builds are including or excluding content as expected if you try to use them.
468
-
====
469
-
470
-
You can filter out the regions defined by a `tag` attribute by using link:https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/#tag-filtering[expressions] in place of or in conjunction with the tag name. If you add tag defined conditional content to a module with no existing tags, you must update existing includes of the file you are changing to exclude your content.
471
-
472
422
== Writing concepts
473
423
A _concept_ contains information to support the tasks that users want to do and
474
424
must not include task information like commands or numbered steps. In most
0 commit comments