diff --git a/doc/openstack-ops/preface_ops.xml b/doc/openstack-ops/preface_ops.xml index 3672c6d0..c653302b 100644 --- a/doc/openstack-ops/preface_ops.xml +++ b/doc/openstack-ops/preface_ops.xml @@ -458,4 +458,5 @@ if you know how to fix it. Also, a member of the OpenStack doc-core team can triage the doc bug. + diff --git a/doc/openstack-ops/section_conventions.xml b/doc/openstack-ops/section_conventions.xml new file mode 100644 index 00000000..01ecb240 --- /dev/null +++ b/doc/openstack-ops/section_conventions.xml @@ -0,0 +1,57 @@ + +
+ + + 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. + + + +