Conventions
The OpenStack documentation uses several typesetting conventions:
Admonitions
Admonitions take three forms:
This is a note. The information in a note is usually in the form
of a handy tip or reminder.
This is important. The information in an important admonition is
something you must be aware of before moving on.
This is a warning. The information in warnings is critical.
Warnings provide additional information about risk of data loss or
security issues.
Command prompts
Commands prefixed with the # prompt are to be
executed by the root user. These examples can
also be executed using the sudo command, if
available.
Commands prefixed with the $ prompt can be
executed by any user, including root.