Skip to content

Commit 23adb69

Browse files
author
Bob Furu
authored
Merge pull request #43861 from bobfuru/no-ital-guide
2 parents 2a49531 + 898ce19 commit 23adb69

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,14 @@ Try to shorten the file name as much as possible _without_ abbreviating importan
180180

181181
== Directory names
182182

183-
If you create a directory with a multiple-word name, separate each word with an underscore, for example `backup_and_restore`. Do not create a top-level directory in the repository without checking with the docs team. In the main OpenShift docs, you can create one level of subdirectories. In the docs for features that are designed to be used with OpenShift, such as Service Mesh and OpenShift Virtualization, you can create two levels of subdirectories.
183+
If you create a directory with a multiple-word name, separate each word with an underscore, for example `backup_and_restore`.
184+
185+
[NOTE]
186+
====
187+
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].
188+
====
189+
190+
Do not create a top-level directory in the repository without checking with the docs team. In the main OpenShift docs, you can create one level of subdirectories. In the docs for features that are designed to be used with OpenShift, such as Service Mesh and OpenShift Virtualization, you can create two levels of subdirectories.
184191

185192
When creating a new directory or subdirectory, you must create four symbolic links in it:
186193

@@ -1035,7 +1042,7 @@ Now using project "my-project" on server "https://openshift.example.com:6443".
10351042
----
10361043
....
10371044

1038-
* 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. For example:
1045+
* 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:
10391046
+
10401047
....
10411048
To view a list of objects for the specified object type, enter the following command:

0 commit comments

Comments
 (0)