Skip to content

Commit 007241f

Browse files
committed
ad-example-for-attribute-title-assembly
1 parent ed9c9cb commit 007241f

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,18 @@ toc::[] <7>
5252
[NOTE]
5353
====
5454
* The `{product-title}` and `{product-version}` common attributes are not defined in the `_attributes/common-attributes.adoc` file. Those attributes are pulled by AsciiBinder from the distro mapping definitions in the https://github.com/openshift/openshift-docs/blob/main/_distro_map.yml[_distro_map.yml] file. See xref:product-name-and-version[Product title and version] and xref:attribute-files[attribute files] for more information on this topic.
55-
* If you use a variable in the title of the first assembly in a section, move the include attributes directive above the title in this assembly. Otherwise, the variable will not render correctly on access.redhat.com.
55+
* If you use a variable in the title of the first assembly in a section, move the include attributes directive above the anchor ID in this assembly. Otherwise, the variable will not render correctly on our documentation portals. For example:
56+
+
57+
[source,text]
58+
----
59+
:_mod-docs-content-type: ASSEMBLY
60+
include::_attributes/common-attributes.adoc[]
61+
[id="installing-ibm-cloud-private"]
62+
= Installing a private cluster on {ibm-cloud-title}
63+
:context: installing-ibm-cloud-private
64+
65+
toc::[]
66+
----
5667
====
5768
+
5869
<5> Context used for identifying headers in modules that is the same as the anchor ID. Example: cli-developer-commands.

0 commit comments

Comments
 (0)