From 0c0dcbca38539187f41ff5752a1def6403ae7c96 Mon Sep 17 00:00:00 2001 From: Ronan Hennessy Date: Fri, 28 Jul 2023 11:05:23 +0100 Subject: [PATCH] The include for common attributes should be moved above the title to avoid attributes not rendering in the title --- contributing_to_docs/doc_guidelines.adoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/contributing_to_docs/doc_guidelines.adoc b/contributing_to_docs/doc_guidelines.adoc index 1abdc0a96da0..ff769debdbdc 100644 --- a/contributing_to_docs/doc_guidelines.adoc +++ b/contributing_to_docs/doc_guidelines.adoc @@ -1,6 +1,6 @@ [id="contributing-to-docs-doc-guidelines"] -= Documentation guidelines include::_attributes/common-attributes.adoc += Documentation guidelines :toc: macro 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 ---- :_content-type: ASSEMBLY <1> [id=""] <2> -= Assembly title <3> -include::_attributes/common-attributes.adoc[] <4> +include::_attributes/common-attributes.adoc[] <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> A unique (within OpenShift docs) anchor ID for this assembly. Use lowercase. Example: cli-developer-commands. +<3> Includes attributes common to OpenShift docs. + [NOTE] ==== 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. ==== + +<4> Human readable title (notice the `=` top-level header). <5> Context used for identifying headers in modules that is the same as the anchor ID. Example: cli-developer-commands. <6> A blank line. You *must* have a blank line here before the toc. <7> The table of contents for the current assembly.