openstack/openstack-manuals
Code Issues Proposed changes
06eed58718
openstack-manuals/doc/common-rst/conventions.rst
venkatamahesh 914a9f6fba [common-rst] Modifications in conventions.rst 
In this patch I added a 'caution' in conventions list
and also modified the explanation for note

Reason: The 'caution' is used in the
file admin-guide-cloud/source/blockstorage-driver-filter-weighing.rst

Change-Id: Ibb1aafad9d7668c666638622d9283a94ad180558
2015-12-18 03:06:51 +00:00

922 B
Raw Blame History

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.

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

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