Skip to content

Commit 5ccb524

Browse files
authored
Merge pull request #63850 from rohennes/revert-include-position-add-note
Reverting include positioning updates
2 parents cefd8fe + 669d294 commit 5ccb524

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[id="contributing-to-docs-doc-guidelines"]
2-
include::_attributes/common-attributes.adoc
32
= Documentation guidelines
3+
include::_attributes/common-attributes.adoc
4+
45
:toc: macro
56

67
The documentation guidelines for OpenShift 4 build on top of the
@@ -37,23 +38,23 @@ Every assembly file should contain the following metadata at the top, with no li
3738
----
3839
:_content-type: ASSEMBLY <1>
3940
[id="<unique-heading-for-assembly>"] <2>
40-
include::_attributes/common-attributes.adoc[] <3>
41-
= Assembly title <4>
41+
= Assembly title <3>
42+
include::_attributes/common-attributes.adoc[] <4>
4243
:context: <unique-context-for-assembly> <5>
4344
<6>
4445
toc::[] <7>
4546
----
46-
4747
<1> The content type for the file. For assemblies, always use `:_content-type: ASSEMBLY`. Place this attribute before the anchor ID or, if present, the conditional that contains the anchor ID.
48-
<2> A unique (within OpenShift docs) anchor ID for this assembly. Use lowercase. Example: cli-developer-commands.
49-
<3> Includes attributes common to OpenShift docs.
48+
<2> A unique (within OpenShift docs) anchor ID for this assembly. Use lowercase. Example: cli-developer-commands
49+
<3> Human readable title (notice the `=` top-level header)
50+
<4> Includes attributes common to OpenShift docs.
5051
+
5152
[NOTE]
5253
====
53-
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.
54+
* 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.
5456
====
5557
+
56-
<4> Human readable title (notice the `=` top-level header).
5758
<5> Context used for identifying headers in modules that is the same as the anchor ID. Example: cli-developer-commands.
5859
<6> A blank line. You *must* have a blank line here before the toc.
5960
<7> The table of contents for the current assembly.

0 commit comments

Comments
 (0)