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
This commit is contained in:
Andreas Jaeger 2015-08-25 19:51:42 +02:00
parent 000ae952b5
commit 7bc799df4e
7 changed files with 41 additions and 0 deletions

View File

@ -17,6 +17,7 @@ Contents
.. toctree::
:maxdepth: 2
common/conventions.rst
common/get_started_with_openstack.rst
identity_management.rst
dashboard.rst

View File

@ -0,0 +1,35 @@
===========
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
~~~~~~~~~~~~~~~
.. code-block:: console
$ command
Any user, including the ``root`` user, can run commands that are
prefixed with the ``$`` prompt.
.. code-block:: console
# command
The ``root`` user must run commands that are prefixed with the ``#``
prompt. You can also prefix these commands with the :command:`sudo`
command, if available, to run them.

View File

@ -50,6 +50,7 @@ Contents
.. toctree::
:maxdepth: 2
common/conventions.rst
overview.rst
basic_environment.rst
debconf/debconf.rst

View File

@ -74,6 +74,7 @@ Contents
.. toctree::
:maxdepth: 2
common/conventions.rst
overview.rst
basic_environment.rst
keystone.rst

View File

@ -26,6 +26,7 @@ Contents
.. toctree::
:maxdepth: 2
common/conventions.rst
intro_networking.rst
intro_os_networking.rst
config.rst

View File

@ -20,6 +20,7 @@ Contents
.. toctree::
:maxdepth: 2
common/conventions.rst
intro-admin.rst
dashboard.rst
cli.rst

View File

@ -20,6 +20,7 @@ Contents
.. toctree::
:maxdepth: 2
common/conventions.rst
intro-user.rst
dashboard.rst
cli.rst