You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributing_to_docs/doc_guidelines.adoc
+4-4
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ toc::[] <7>
41
41
+
42
42
[NOTE]
43
43
====
44
-
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.
44
+
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.
45
45
====
46
46
+
47
47
<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
393
393
----
394
394
395
395
[id="product-name-and-version"]
396
-
== Product name and version
396
+
== Product title and version
397
397
398
398
When possible, generalize references to the product name and/or version by using
399
399
the `{product-title}` and/or `{product-version}` attributes. These attributes
@@ -419,7 +419,7 @@ possible values for `{product-title}` and `{product-version}`.
@@ -1516,7 +1516,7 @@ Nest admonitions when using the `collapsible` option.
1516
1516
Do not use a password format that matches the format of a real password. Documenting such a password format can cause the following issues:
1517
1517
1518
1518
* Indicates that Red Hat publicly exposes sensitive data in their documentation.
1519
-
* 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.
1519
+
* 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.
0 commit comments