Skip to content

Commit

Permalink
The include for common attributes should be moved above the title to …
Browse files Browse the repository at this point in the history
…avoid attributes not rendering in the title
  • Loading branch information
rohennes committed Jul 28, 2023
1 parent 34f32dd commit 0a5e53d
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions contributing_to_docs/doc_guidelines.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
include::_attributes/common-attributes.adoc
[id="contributing-to-docs-doc-guidelines"]
= Documentation guidelines
include::_attributes/common-attributes.adoc
:toc: macro

The documentation guidelines for OpenShift 4 build on top of the
Expand Down Expand Up @@ -36,18 +36,18 @@ Every assembly file should contain the following metadata at the top, with no li

----
:_content-type: ASSEMBLY <1>
[id="<unique-heading-for-assembly>"] <2>
= Assembly title <3>
include::_attributes/common-attributes.adoc[] <4>
include::_attributes/common-attributes.adoc[] <2>
[id="<unique-heading-for-assembly>"] <3>
= Assembly title <4>
:context: <unique-context-for-assembly> <5>
<6>
toc::[] <7>
----

<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.
<2> A unique (within OpenShift docs) anchor ID for this assembly. Use lowercase. Example: cli-developer-commands
<3> Human readable title (notice the `=` top-level header)
<4> Includes attributes common to OpenShift docs.
<2> Includes attributes common to OpenShift docs.
<3> A unique (within OpenShift docs) anchor ID for this assembly. Use lowercase. Example: cli-developer-commands
<4> Human readable title (notice the `=` top-level header)
+
[NOTE]
====
Expand Down

0 comments on commit 0a5e53d

Please sign in to comment.