openstack/openstack-manuals
Code Issues Proposed changes
e0cf7852ba
openstack-manuals/doc/common-rst/conventions.rst
Andreas Jaeger 7bc799df4e RST Guides: Add conventions section 
Converting from DocBook to XML we lost the initial conventions section,
write it and add it to all RST guides.

Change-Id: I2ff3d863c72af97a3f70a1ae34083623b7c7006e
2015-08-25 19:53:33 +02:00

722 B
Raw Blame History

Conventions

The OpenStack documentation uses several typesetting conventions.

Notices

Notices take these forms:

Note

A handy tip or reminder.

Important

Something you must be aware of before proceeding.

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.