Merge "RST Guides: Add conventions section"

doc/admin-guide-cloud/source/index.rst

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

doc/common-rst/conventions.rst

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

doc/install-guide/source/index-debian.rst

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

doc/install-guide/source/index.rst

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

doc/networking-guide/source/index.rst

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

doc/user-guide-admin/source/index.rst

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

doc/user-guide/source/index.rst

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