Conventions

Conventions

The OpenStack documentation uses several typesetting conventions.

Notices

Notices take these forms:

注釈

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

重要

Something you must be aware of before proceeding.

ちなみに

An extra but helpful piece of practical advice.

ご用心

Helpful information that prevents the user from making mistakes.

警告

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.

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.