Skip to content

Commit bdd8001

Browse files
Merge pull request #62912 from rohennes/move-attributes-above-title
2 parents 91ef27f + 0c0dcbc commit bdd8001

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

contributing_to_docs/doc_guidelines.adoc

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

66
The documentation guidelines for OpenShift 4 build on top of the
@@ -37,23 +37,23 @@ Every assembly file should contain the following metadata at the top, with no li
3737
----
3838
:_content-type: ASSEMBLY <1>
3939
[id="<unique-heading-for-assembly>"] <2>
40-
= Assembly title <3>
41-
include::_attributes/common-attributes.adoc[] <4>
40+
include::_attributes/common-attributes.adoc[] <3>
41+
= Assembly title <4>
4242
:context: <unique-context-for-assembly> <5>
4343
<6>
4444
toc::[] <7>
4545
----
4646

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> Human readable title (notice the `=` top-level header)
50-
<4> 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> Includes attributes common to OpenShift docs.
5150
+
5251
[NOTE]
5352
====
5453
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.
5554
====
5655
+
56+
<4> Human readable title (notice the `=` top-level header).
5757
<5> Context used for identifying headers in modules that is the same as the anchor ID. Example: cli-developer-commands.
5858
<6> A blank line. You *must* have a blank line here before the toc.
5959
<7> The table of contents for the current assembly.

0 commit comments

Comments
 (0)