diff --git a/deploy-guide/source/navigation.txt b/deploy-guide/source/navigation.txt deleted file mode 100644 index 57b709815b..0000000000 --- a/deploy-guide/source/navigation.txt +++ /dev/null @@ -1,4 +0,0 @@ -* `Documentation Home <../index.html>`_ -* `Installation Guide `_ -* `Upgrade Guide <../upgrade-guide/index.html>`_ -* `Developer Documentation <../developer-docs/index.html>`_ diff --git a/doc/source/developer-docs/additional-roles.rst b/doc/source/developer-docs/additional-roles.rst index da08b863bc..5cac6bef5a 100644 --- a/doc/source/developer-docs/additional-roles.rst +++ b/doc/source/developer-docs/additional-roles.rst @@ -1,5 +1,4 @@ -`Home `_ OpenStack-Ansible Developer Documentation - +============================= Adding new Roles and Services ============================= @@ -322,7 +321,3 @@ The development of a role will usually go through the following stages: test must execute a set of functional tests using Tempest. This is the required last step before a service can remove the experimental warning from the documentation. - --------------- - -.. include:: navigation.txt diff --git a/doc/source/developer-docs/bug-triage.rst b/doc/source/developer-docs/bug-triage.rst index 9400f1ed7c..3d4c99b6a6 100644 --- a/doc/source/developer-docs/bug-triage.rst +++ b/doc/source/developer-docs/bug-triage.rst @@ -1,5 +1,3 @@ -`Home `_ OpenStack-Ansible Developer Documentation - ============================ OpenStack-Ansible Bug Triage ============================ @@ -142,7 +140,3 @@ Bug skimming duty weekly checklist .. _wishlist bugs: https://bugs.launchpad.net/openstack-ansible/+bugs?field.searchtext=&orderby=datecreated&search=Search&field.importance%3Alist=WISHLIST&assignee_option=any&field.assignee=&field.bug_reporter=&field.bug_commenter=&field.subscriber=&field.structural_subscriber=&field.tag=&field.tags_combinator=ANY&field.has_cve.used=&field.omit_dupes.used=&field.omit_dupes=on&field.affects_me.used=&field.has_patch.used=&field.has_branches.used=&field.has_branches=on&field.has_no_branches.used=&field.has_no_branches=on&field.has_blueprints.used=&field.has_blueprints=on&field.has_no_blueprints.used=&field.has_no_blueprints=on .. _list of bugs to triage: https://bugs.launchpad.net/openstack-ansible/+bugs?search=Search&field.status=New - --------------- - -.. include:: navigation.txt diff --git a/doc/source/developer-docs/contribute.rst b/doc/source/developer-docs/contribute.rst index 3330276b26..04253171f4 100644 --- a/doc/source/developer-docs/contribute.rst +++ b/doc/source/developer-docs/contribute.rst @@ -1,5 +1,3 @@ -`Home `_ OpenStack-Ansible Developer Documentation - ====================== Contributor Guidelines ====================== @@ -342,7 +340,3 @@ development team by performing one of the following recurring tasks: * After milestone 3: * Feature freeze, bug fixes, and testing improvements - --------------- - -.. include:: navigation.txt diff --git a/doc/source/developer-docs/core-reviewers.rst b/doc/source/developer-docs/core-reviewers.rst index c2e5da6f30..00e894248f 100644 --- a/doc/source/developer-docs/core-reviewers.rst +++ b/doc/source/developer-docs/core-reviewers.rst @@ -1,5 +1,4 @@ -`Home `_ OpenStack-Ansible Developer Documentation - +============== Core Reviewers ============== @@ -64,8 +63,3 @@ affects things like documentation, testing, upgrade impacts and interactions with other projects. It also means you pay attention to release milestones and understand if a patch you are merging is marked for the release, especially critical during the feature freeze. - - --------------- - -.. include:: navigation.txt diff --git a/doc/source/developer-docs/index.rst b/doc/source/developer-docs/index.rst index d4acb1ceb8..d6c49193f1 100644 --- a/doc/source/developer-docs/index.rst +++ b/doc/source/developer-docs/index.rst @@ -1,4 +1,5 @@ -Developer Documentation +======================= +Developer documentation ======================= In this section, you will find documentation relevant to developing diff --git a/doc/source/developer-docs/installation-hosts-limited-connectivity.rst b/doc/source/developer-docs/installation-hosts-limited-connectivity.rst index d5c0039cf3..1e00ae1f04 100644 --- a/doc/source/developer-docs/installation-hosts-limited-connectivity.rst +++ b/doc/source/developer-docs/installation-hosts-limited-connectivity.rst @@ -175,7 +175,3 @@ behavior when used in concert with many popular proxy servers and configurations. An example Launchpad bug can be found `here `_. The comments contain a workaround that has been effective for some deployers. - --------------- - -.. include:: navigation.txt diff --git a/doc/source/developer-docs/inventory.rst b/doc/source/developer-docs/inventory.rst index 6e0aeb61f1..303af613ca 100644 --- a/doc/source/developer-docs/inventory.rst +++ b/doc/source/developer-docs/inventory.rst @@ -1,7 +1,6 @@ -`Home `_ OpenStack-Ansible Developer Documentation - .. _developer-inventory: +=========================== OpenStack-Ansible Inventory =========================== @@ -217,7 +216,3 @@ Dynamic Inventory API documentation .. automodule:: dynamic_inventory :members: - --------------- - -.. include:: navigation.txt diff --git a/doc/source/developer-docs/navigation.txt b/doc/source/developer-docs/navigation.txt deleted file mode 100644 index 013f4d4f1e..0000000000 --- a/doc/source/developer-docs/navigation.txt +++ /dev/null @@ -1,4 +0,0 @@ -* `Documentation Home <../index.html>`_ -* `Installation Guide `_ -* `Upgrade Guide <../upgrade-guide/index.html>`_ -* `Developer Documentation `_ diff --git a/doc/source/developer-docs/playbooks.rst b/doc/source/developer-docs/playbooks.rst index 6d7e4ab041..61ea80e8b8 100644 --- a/doc/source/developer-docs/playbooks.rst +++ b/doc/source/developer-docs/playbooks.rst @@ -1,5 +1,4 @@ -`Home `_ OpenStack-Ansible Developer Documentation - +========= Playbooks ========= @@ -68,7 +67,3 @@ After successful deployment, you are able to update variables in pass completes, you may introduce unavailability in your cluster. This should only be used for testing or fully rebalanced clusters. - --------------- - -.. include:: navigation.txt diff --git a/doc/source/developer-docs/quickstart-aio.rst b/doc/source/developer-docs/quickstart-aio.rst index ce73cca1ce..4e6387d594 100644 --- a/doc/source/developer-docs/quickstart-aio.rst +++ b/doc/source/developer-docs/quickstart-aio.rst @@ -1,5 +1,4 @@ -`Home `_ OpenStack-Ansible Developer Documentation - +=========== Quick Start =========== @@ -68,8 +67,9 @@ repository root directory: Next switch the applicable branch/tag to be deployed from. Note that deploying from the head of a branch may result in an unstable build due to -changes in flight and upstream OpenStack changes. For a test (ie not a -development) build it is usually best to checkout the latest tagged version. +changes in flight and upstream OpenStack changes. For a test (for example, +not a development) build it is usually best to checkout the latest tagged +version. .. parsed-literal:: @@ -101,8 +101,8 @@ development environment. The bootstrap script is pre-set to pass the environment variable ``BOOTSTRAP_OPTS`` as an additional option to the bootstrap process. For example, if you wish to set the bootstrap to re-partition a specific -secondary storage device (/dev/sdb), which will erase all of the data on the -device, then execute: +secondary storage device (``/dev/sdb``), which will erase all of the data +on the device, then execute: .. code-block:: shell-session @@ -116,8 +116,8 @@ a space between each set of options, for example: # export BOOTSTRAP_OPTS="bootstrap_host_data_disk_device=sdb" # export BOOTSTRAP_OPTS="${BOOTSTRAP_OPTS} bootstrap_host_ubuntu_repo=http://mymirror.example.com/ubuntu" -You may wish to change the role fetch mode. Options are "galaxy" and -"git-clone". The default for this option is "galaxy". +You may wish to change the role fetch mode. Options are ``galaxy`` and +``git-clone``. The default for this option is ``galaxy``. options: :galaxy: Resolve all role dependencies using the ``ansible-galaxy`` resolver @@ -125,10 +125,10 @@ options: Notes: When doing role development it may be useful to set - ``ANSIBLE_ROLE_FETCH_MODE`` to *git-clone*. This will provide you the + ``ANSIBLE_ROLE_FETCH_MODE`` to ``git-clone``. This will provide you the ability to develop roles within the environment by modifying, patching, or - committing changes using an intact git tree while the *galaxy* option scrubs - the ``.git`` directory when it resolves a dependency. + committing changes using an intact git tree while the ``galaxy`` option + scrubs the ``.git`` directory when it resolves a dependency. .. code-block:: bash @@ -153,7 +153,7 @@ for the OpenStack Deployment. This preparation is completed by executing: If you wish to add any additional configuration entries for the OpenStack configuration then this can be done now by editing -``/etc/openstack_deploy/user_variables.yml``. Please see the `Install Guide`_ +``/etc/openstack_deploy/user_variables.yml``. See the `Deployment Guide`_ for more details. Finally, run the playbooks by executing: @@ -193,7 +193,7 @@ Keystone service, execute: that are not requested for deployment, but the service will not be deployed in that container. -.. _Install Guide: ../install-guide/ +.. _Deployment Guide: http://docs.openstack.org/project-deploy-guide/openstack-ansible/draft/ Rebooting an AIO ---------------- @@ -210,7 +210,7 @@ This is done by executing the following: If this fails to get the database cluster back into a running state, then please make use of the `Galera Cluster Recovery`_ page in the Install Guide. -.. _Galera Cluster Recovery: http://docs.openstack.org/developer/openstack-ansible/developer-docs/ops-galera-recovery.html +.. _Galera Cluster Recovery: http://docs.openstack.org/developer/openstack-ansible/draft-operations-guide/maintenance-tasks/galera.html#galera-cluster-recovery Rebuilding an AIO ----------------- @@ -312,7 +312,3 @@ built for informational purposes only and should **ONLY** be used as such. | | | | | | | | | V | | * | ---->[ Compute ]*[ Neutron linuxbridge ]<---| |->[ Swift storage ]- - --------------- - -.. include:: navigation.txt diff --git a/doc/source/developer-docs/role-services.rst b/doc/source/developer-docs/role-services.rst index 872b1874ee..fe7c55b4d5 100644 --- a/doc/source/developer-docs/role-services.rst +++ b/doc/source/developer-docs/role-services.rst @@ -1,5 +1,4 @@ -`Home `_ OpenStack-Ansible Developer Documentation - +================== Roles and services ================== diff --git a/doc/source/developer-docs/scripts.rst b/doc/source/developer-docs/scripts.rst index b624b5a3f6..b512dadd38 100644 --- a/doc/source/developer-docs/scripts.rst +++ b/doc/source/developer-docs/scripts.rst @@ -1,5 +1,4 @@ -`Home `_ OpenStack-Ansible Developer Documentation - +================ Included Scripts ================ @@ -231,7 +230,3 @@ following jobs: While this script is primarily developed and maintained for use in OpenStack-CI, it can be used in other environments. - --------------- - -.. include:: navigation.txt diff --git a/doc/source/upgrade-guide/navigation.txt b/doc/source/upgrade-guide/navigation.txt deleted file mode 100644 index c3d709f1a4..0000000000 --- a/doc/source/upgrade-guide/navigation.txt +++ /dev/null @@ -1,4 +0,0 @@ -* `Documentation Home <../index.html>`_ -* `Installation Guide `_ -* `Upgrade Guide `_ -* `Developer Documentation <../developer-docs/index.html>`_