openstack/openstack-ansible
Code Issues Proposed changes

deploy-guide: fix small rst format issues

Browse Source 
This fixes a few minor rst format issues like:
* nested lists which were shown as blockquote
* code-blocks which were show as blockquote
* underlining of titles which didn't match
* missing backslash escaping in parsed-literal

Change-Id: I9b0934112f7f26775af52b6fc7de9fd29b215998
This commit is contained in:
Markus Zoeller 2017-03-28 18:38:06 +02:00
parent a74b741c87
commit 9603b8a04e
10 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
deploy-guide/source/app-advanced-config-options.rst
View File

@ -1,6 +1,6 @@
=================================== ==================================
Appendix G: Advanced configuration Appendix G: Advanced configuration
=================================== ==================================
.. TODO: include intro on what advanced configuration is, whether it’s required .. TODO: include intro on what advanced configuration is, whether it’s required
or optional, and when someone should do it or optional, and when someone should do it

2
deploy-guide/source/app-advanced-config-override.rst
View File

@ -131,7 +131,7 @@ overrides, the general format for the variable name is
``<service>_policy_overrides``. ``<service>_policy_overrides``.
Overriding .yml files Overriding .yml files
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
You can override ``.yml`` file values by supplying replacement YAML content. You can override ``.yml`` file values by supplying replacement YAML content.

2
deploy-guide/source/app-config-prod.rst
View File

@ -87,7 +87,7 @@ following is the ``/etc/network/interfaces`` file for ``infra1``.
.. literalinclude:: ../../etc/network/interfaces.d/openstack_interface.cfg.prod.example .. literalinclude:: ../../etc/network/interfaces.d/openstack_interface.cfg.prod.example
Deployment configuration Deployment configuration
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
Environment layout Environment layout
------------------ ------------------

2
deploy-guide/source/app-config-test.rst
View File

@ -74,7 +74,7 @@ following is the ``/etc/network/interfaces`` file for ``infra1``.
.. literalinclude:: ../../etc/network/interfaces.d/openstack_interface.cfg.test.example .. literalinclude:: ../../etc/network/interfaces.d/openstack_interface.cfg.test.example
Deployment configuration Deployment configuration
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
Environment layout Environment layout
------------------ ------------------

4
deploy-guide/source/app-custom-layouts.rst
View File

@ -1,6 +1,6 @@
================================================== ================================================
Appendix C: Customizing host and service layouts Appendix C: Customizing host and service layouts
================================================== ================================================
The default layout of containers and services in OpenStack-Ansible (OSA) is The default layout of containers and services in OpenStack-Ansible (OSA) is
determined by the ``/etc/openstack_deploy/openstack_user_config.yml`` file and determined by the ``/etc/openstack_deploy/openstack_user_config.yml`` file and

4
deploy-guide/source/app-resources.rst
View File

@ -1,6 +1,6 @@
================================= ================================
Appendix I: Additional resources Appendix I: Additional resources
================================= ================================
Ansible resources: Ansible resources:

4
deploy-guide/source/app-security.rst
View File

@ -1,6 +1,6 @@
===================== ====================
Appendix D: Security Appendix D: Security
===================== ====================
Security is one of the top priorities within OpenStack-Ansible (OSA), and many Security is one of the top priorities within OpenStack-Ansible (OSA), and many
security enhancements for OpenStack clouds are available in deployments by security enhancements for OpenStack clouds are available in deployments by

4
deploy-guide/source/configure.rst
View File

@ -58,7 +58,7 @@ configuration, see
`developer-inventory <http://docs.openstack.org/developer/openstack-ansible/developer-docs/inventory.html>`_. `developer-inventory <http://docs.openstack.org/developer/openstack-ansible/developer-docs/inventory.html>`_.
Installing additional services Installing additional services
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To install additional services, the files in To install additional services, the files in
``/etc/openstack_deploy/conf.d`` provide examples showing ``/etc/openstack_deploy/conf.d`` provide examples showing
@ -172,7 +172,7 @@ password for both the OpenStack API and Dashboard access.
We recommend that you use the ``pw-token-gen.py`` script to generate random We recommend that you use the ``pw-token-gen.py`` script to generate random
values for the variables in each file that contains service credentials: values for the variables in each file that contains service credentials:
.. code-block:: shell-session .. code-block:: shell-session
# cd /opt/openstack-ansible/scripts # cd /opt/openstack-ansible/scripts
# python pw-token-gen.py --file /etc/openstack_deploy/user_secrets.yml # python pw-token-gen.py --file /etc/openstack_deploy/user_secrets.yml

2
deploy-guide/source/deploymenthost.rst
View File

@ -118,7 +118,7 @@ Install the source and dependencies for the deployment host.
.. parsed-literal:: .. parsed-literal::
# git clone -b |latest_tag| https://git.openstack.org/openstack/openstack-ansible \ # git clone -b |latest_tag| https://git.openstack.org/openstack/openstack-ansible \\
/opt/openstack-ansible /opt/openstack-ansible
#. Change to the ``/opt/openstack-ansible`` directory, and run the #. Change to the ``/opt/openstack-ansible`` directory, and run the