OpsGuide/Conventions

Conventions

The OpenStack documentation uses several typesetting conventions.

Notices

Notices take these forms:

Notice

A comment with additional information that explains a part of the text.

Important

Something you must be aware of before proceeding.

Tip

An extra, but helpful piece of practical advice.

Caution

Helpful information that prevents the user from making mistakes.

Warning

Critical information about the risk of data loss or security issues.

Command prompts

normal user command

$ command

Any user, including the root user, can run commands that are prefixed with the $ prompt.

root command

# 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.