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
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -192,11 +192,6 @@ Try to shorten the file name as much as possible _without_ abbreviating importan
192
192
193
193
If you create a directory with a multiple-word name, separate each word with an underscore, for example `backup_and_restore`.
194
194
195
-
[NOTE]
196
-
====
197
-
Do not italicize user-replaced values. This guideline is an exception to the link:https://redhat-documentation.github.io/supplementary-style-guide/#user-replaced-values[_Red Hat supplementary style guide for product documentation_].
198
-
====
199
-
200
195
Do not create or rename a top-level directory in the repository and topic map without checking with the docs program manager first.
201
196
202
197
Avoid creating two levels of subdirectories because the link:https://github.com/openshift/openshift-docs/issues/52149[breadcrumb bar on docs.openshift.com breaks]. If you have a valid use case for two levels of subdirectories, talk with your DPM/CS (and, for aligned teams, the OpenShift DPM) for approval before creating it.
@@ -1165,7 +1160,14 @@ Now using project "my-project" on server "https://openshift.example.com:6443".
1165
1160
----
1166
1161
....
1167
1162
1168
-
* To mark up command syntax, use the code block and wrap any replaceable values in angle brackets (`<>`) with the required command parameter, using underscores (`_`) between words as necessary for legibility. Do not italicize user-replaced values. For example:
1163
+
* To mark up command syntax, use the code block and wrap any replaceable values in angle brackets (`<>`) with the required command parameter, using underscores (`_`) between words as necessary for legibility.
1164
+
+
1165
+
[IMPORTANT]
1166
+
====
1167
+
Do not italicize user-replaced values. This guideline is an exception to the link:https://redhat-documentation.github.io/supplementary-style-guide/#user-replaced-values[_Red Hat supplementary style guide for product documentation_].
1168
+
====
1169
+
+
1170
+
For example:
1169
1171
+
1170
1172
....
1171
1173
To view a list of objects for the specified object type, enter the following command:
@@ -1679,7 +1681,7 @@ Nest admonitions when using the `collapsible` option.
1679
1681
Do not use a password format that matches the format of a real password. Documenting such a password format can cause the following issues:
1680
1682
1681
1683
* Indicates that Red Hat publicly exposes sensitive data in their documentation.
1682
-
* 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.
1684
+
* 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