diff --git a/doc/admin-guide-cloud/source/index.rst b/doc/admin-guide-cloud/source/index.rst index abd729f90a..6d4771dbff 100644 --- a/doc/admin-guide-cloud/source/index.rst +++ b/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 diff --git a/doc/common-rst/conventions.rst b/doc/common-rst/conventions.rst new file mode 100644 index 0000000000..e858db7028 --- /dev/null +++ b/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. diff --git a/doc/install-guide/source/index-debian.rst b/doc/install-guide/source/index-debian.rst index c269635b90..76777d6bfa 100644 --- a/doc/install-guide/source/index-debian.rst +++ b/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 diff --git a/doc/install-guide/source/index.rst b/doc/install-guide/source/index.rst index d9b08011f5..ab0e9886a8 100644 --- a/doc/install-guide/source/index.rst +++ b/doc/install-guide/source/index.rst @@ -74,6 +74,7 @@ Contents .. toctree:: :maxdepth: 2 + common/conventions.rst overview.rst basic_environment.rst keystone.rst diff --git a/doc/networking-guide/source/index.rst b/doc/networking-guide/source/index.rst index 619456c599..0f57e34969 100644 --- a/doc/networking-guide/source/index.rst +++ b/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 diff --git a/doc/user-guide-admin/source/index.rst b/doc/user-guide-admin/source/index.rst index 86f6f5105d..6bc4e8c320 100644 --- a/doc/user-guide-admin/source/index.rst +++ b/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 diff --git a/doc/user-guide/source/index.rst b/doc/user-guide/source/index.rst index acc5bca01f..325037ae8b 100644 --- a/doc/user-guide/source/index.rst +++ b/doc/user-guide/source/index.rst @@ -20,6 +20,7 @@ Contents .. toctree:: :maxdepth: 2 + common/conventions.rst intro-user.rst dashboard.rst cli.rst