diff --git a/contributing_to_docs/doc_guidelines.adoc b/contributing_to_docs/doc_guidelines.adoc index 1a28f19162ce..45c98febd748 100644 --- a/contributing_to_docs/doc_guidelines.adoc +++ b/contributing_to_docs/doc_guidelines.adoc @@ -41,7 +41,7 @@ toc::[] <7> + [NOTE] ==== -The `{product-name}` 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 name and version] for more information on this topic. +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] for more information on this topic. ==== + <5> Context used for identifying headers in modules that is the same as the anchor ID. Example: cli-developer-commands. @@ -393,7 +393,7 @@ If you create a release notes assembly for a sub-product within the `openshift/o ---- [id="product-name-and-version"] -== Product name and version +== Product title and version When possible, generalize references to the product name and/or version by using the `{product-title}` and/or `{product-version}` attributes. These attributes @@ -419,7 +419,7 @@ possible values for `{product-title}` and `{product-version}`. |`openshift-enterprise` |OpenShift Container Platform -|3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.9, 3.10, 3.11, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7 +|3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.9, 3.10, 3.11, 4.1, 4.2, 4.3, 4.4, 4.5, 4.6, 4.7, 4.8, 4.9, 4.10, 4.11, 4.12 |`openshift-dedicated` |OpenShift Dedicated @@ -1516,7 +1516,7 @@ Nest admonitions when using the `collapsible` option. Do not use a password format that matches the format of a real password. Documenting such a password format can cause the following issues: * Indicates that Red Hat publicly exposes sensitive data in their documentation. -* Leads to additional security incidents that the Information Security, InfoSec, team must investigate. Such security incidents, although minor, can impact the InfoSec team's resources and potentially delay them from focusing on actual security incidents. +* Leads to additional security incidents that the Information Security, InfoSec, team must investigate. Such security incidents, although minor, can impact the InfoSec team's resources and potentially delay them from focusing on actual security incidents. ==== .Projects and applications