Skip to content

Commit d527370

Browse files
committed
resource name formatting guidelines
1 parent 7dc029c commit d527370

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1126,6 +1126,10 @@ This renders as:
11261126
+
11271127
NOTE: Avoid using full command syntax inline with sentences.
11281128

1129+
* When you specify link:https://kubernetes.io/docs/reference/kubectl/#resource-types[resource names] in `oc` commands, use the full name of the resource type by default. You can use the abbreviation of the resource type name if it improves readability, such as with very long commands, or to be consistent with existing content in the same assembly.
1130+
+
1131+
For example, use `namespaces` instead of `ns` and `poddisruptionbudgets` instead of `pdb`.
1132+
11291133
* When referring to a path to a location that the user has selected or created, treat the part of the path that the user chose as a replaceable value. For example:
11301134
+
11311135
....

0 commit comments

Comments
 (0)