Conventions¶
The OpenStack documentation uses several typesetting conventions.
Notices¶
Notices take these forms:
Note
A comment with additional information that explains a part of the text.
Important
Something you must be aware of before proceeding.
Astuce
An extra but helpful piece of practical advice.
Prudence
Helpful information that prevents the user from making mistakes.
Avertissement
Critical information about the risk of data loss or security issues.
Command prompts¶
$ command
Any user, including the root
user, can run commands that are
prefixed with the $
prompt.
# command
The root
user must run commands that are prefixed with the #
prompt. You can also prefix these commands with the sudo
command, if available, to run them.