Skip to content

Commit fa8fa4e

Browse files
authored
Clarify use of # and $ in code blocks
1 parent 9652f6c commit fa8fa4e

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

contributing_to_docs/doc_guidelines.adoc

+7
Original file line numberDiff line numberDiff line change
@@ -467,6 +467,13 @@ $ oc get endpoints --all-namespaces --template \
467467
{{ end }}{{ end }}{{ "\n" }}{{ end }}' | awk '/ 172\.30\./ { print $1 }'
468468
----
469469

470+
* If the user must run a command as root, use a number sign, `#`, at the start of the command instead of a dollar sign, `$`. For example:
471+
+
472+
[source, bash]
473+
----
474+
# sudo ./openshift start
475+
----
476+
470477
=== Inline Code or Commands
471478
Do NOT show full commands or command syntax inline within a sentence. The next section covers how to show commands and command syntax.
472479

0 commit comments

Comments
 (0)