diff --git a/contributing_to_docs/doc_guidelines.adoc b/contributing_to_docs/doc_guidelines.adoc index 1abdc0a96da0..27b450ed2fb3 100644 --- a/contributing_to_docs/doc_guidelines.adoc +++ b/contributing_to_docs/doc_guidelines.adoc @@ -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 @@ -36,18 +36,18 @@ Every assembly file should contain the following metadata at the top, with no li ---- :_content-type: ASSEMBLY <1> -[id=""] <2> -= Assembly title <3> -include::_attributes/common-attributes.adoc[] <4> +include::_attributes/common-attributes.adoc[] <2> +[id=""] <3> += Assembly title <4> :context: <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] ====