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: supplementary_style_guide/style_guidelines/code-commands.adoc
+22-2
Original file line number
Diff line number
Diff line change
@@ -21,14 +21,14 @@ Do not rely solely on a shell prompt in a sample command to indicate the require
21
21
If you include a shell prompt to indicate that a user with root privileges must run the command, also include a statement about this requirement in the step text, the introductory text, or the prerequisites.
22
22
====
23
23
+
24
-
* When a sample command includes `sudo`, use the `$` prompt, not `#`, as shown in the following example:
24
+
* When a sample command includes `sudo`, use the `$` prompt, not `#`, as shown in the following example:
25
25
+
26
26
[source,terminal]
27
27
----
28
28
$ sudo systemctl start firewalld
29
29
----
30
30
+
31
-
* If multiple commands in a procedure require root privileges, add introductory content to tell the user about the requirement.
31
+
* If multiple commands in a procedure require root privileges, add introductory content to tell the user about the requirement.
32
32
The following example shows one way that you could integrate a requirement for root access into the introduction for a procedure:
33
33
+
34
34
.Example AsciiDoc
@@ -39,6 +39,26 @@ Some tasks in this procedure require root privileges, which you can get temporar
39
39
.Additional resources
40
40
* link:https://www.redhat.com/sysadmin/difference-between-sudo-su[Exploring the differences between sudo and su commands in Linux]
41
41
42
+
[[ellipses-in-yaml-code-blocks]]
43
+
== Ellipses in YAML code blocks
44
+
45
+
Use the number sign (`#`) to comment out an ellipsis in YAML code blocks.
46
+
YAML reserves `...` to indicate the end of a document without starting a new document.
0 commit comments