openstack/openstack-ansible
Code Issues Proposed changes

[docs] Removing navigation.txt file

Browse Source 
After the updates to the new theme, there is no need for the
navigation.txt file. Removing entirely for master.

Partial-bug: 1652948

Change-Id: I8e4b2384062f01a44d979dbb0c350702b7c9adbe
This commit is contained in:
Alexandra Settle 2017-01-10 14:04:28 +00:00
parent 7915813238
commit 41d4fd8fc0
14 changed files with 22 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
deploy-guide/source/navigation.txt
View File

@ -1,4 +0,0 @@
* `Documentation Home <../index.html>`_
* `Installation Guide <index.html>`_
* `Upgrade Guide <../upgrade-guide/index.html>`_
* `Developer Documentation <../developer-docs/index.html>`_

7
doc/source/developer-docs/additional-roles.rst
View File

@ -1,5 +1,4 @@
`Home <index.html>`_ OpenStack-Ansible Developer Documentation =============================
Adding new Roles and Services 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 test must execute a set of functional tests using Tempest. This is the
required last step before a service can remove the experimental warning required last step before a service can remove the experimental warning
from the documentation. from the documentation.
--------------
.. include:: navigation.txt

6
doc/source/developer-docs/bug-triage.rst
View File

@ -1,5 +1,3 @@
`Home <index.html>`_ OpenStack-Ansible Developer Documentation
============================ ============================
OpenStack-Ansible Bug Triage 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 .. _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 .. _list of bugs to triage: https://bugs.launchpad.net/openstack-ansible/+bugs?search=Search&field.status=New
--------------
.. include:: navigation.txt

6
doc/source/developer-docs/contribute.rst
View File

@ -1,5 +1,3 @@
`Home <index.html>`_ OpenStack-Ansible Developer Documentation
====================== ======================
Contributor Guidelines Contributor Guidelines
====================== ======================
@ -342,7 +340,3 @@ development team by performing one of the following recurring tasks:
* After milestone 3: * After milestone 3:
* Feature freeze, bug fixes, and testing improvements * Feature freeze, bug fixes, and testing improvements
--------------
.. include:: navigation.txt

8
doc/source/developer-docs/core-reviewers.rst
View File

@ -1,5 +1,4 @@
`Home <index.html>`_ OpenStack-Ansible Developer Documentation ==============
Core Reviewers 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 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 understand if a patch you are merging is marked for the release, especially
critical during the feature freeze. critical during the feature freeze.
--------------
.. include:: navigation.txt

3
doc/source/developer-docs/index.rst
View File

@ -1,4 +1,5 @@
Developer Documentation =======================
Developer documentation
======================= =======================
In this section, you will find documentation relevant to developing In this section, you will find documentation relevant to developing

4
doc/source/developer-docs/installation-hosts-limited-connectivity.rst
View File

@ -175,7 +175,3 @@ behavior when used in concert with many popular proxy servers and
configurations. An example Launchpad bug can be found `here configurations. An example Launchpad bug can be found `here
<https://bugs.launchpad.net/openstack-ansible/+bug/1556975/>`_. The comments <https://bugs.launchpad.net/openstack-ansible/+bug/1556975/>`_. The comments
contain a workaround that has been effective for some deployers. contain a workaround that has been effective for some deployers.
--------------
.. include:: navigation.txt

7
doc/source/developer-docs/inventory.rst
View File

@ -1,7 +1,6 @@
`Home <index.html>`_ OpenStack-Ansible Developer Documentation
.. _developer-inventory: .. _developer-inventory:
===========================
OpenStack-Ansible Inventory OpenStack-Ansible Inventory
=========================== ===========================
@ -217,7 +216,3 @@ Dynamic Inventory API documentation
.. automodule:: dynamic_inventory .. automodule:: dynamic_inventory
:members: :members:
--------------
.. include:: navigation.txt

4
doc/source/developer-docs/navigation.txt
View File

@ -1,4 +0,0 @@
* `Documentation Home <../index.html>`_
* `Installation Guide <http://docs.openstack.org/project-deploy-guide/openstack-ansible/draft/>`_
* `Upgrade Guide <../upgrade-guide/index.html>`_
* `Developer Documentation <index.html>`_

7
doc/source/developer-docs/playbooks.rst
View File

@ -1,5 +1,4 @@
`Home <index.html>`_ OpenStack-Ansible Developer Documentation =========
Playbooks Playbooks
========= =========
@ -68,7 +67,3 @@ After successful deployment, you are able to update variables in
pass completes, you may introduce unavailability in your cluster. pass completes, you may introduce unavailability in your cluster.
This should only be used for testing or fully rebalanced clusters. This should only be used for testing or fully rebalanced clusters.
--------------
.. include:: navigation.txt

32
doc/source/developer-docs/quickstart-aio.rst
View File

@ -1,5 +1,4 @@
`Home <index.html>`_ OpenStack-Ansible Developer Documentation ===========
Quick Start Quick Start
=========== ===========
@ -68,8 +67,9 @@ repository root directory:
Next switch the applicable branch/tag to be deployed from. Note that 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 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 changes in flight and upstream OpenStack changes. For a test (for example,
development) build it is usually best to checkout the latest tagged version. not a development) build it is usually best to checkout the latest tagged
version.
.. parsed-literal:: .. parsed-literal::
@ -101,8 +101,8 @@ development environment.
The bootstrap script is pre-set to pass the environment variable The bootstrap script is pre-set to pass the environment variable
``BOOTSTRAP_OPTS`` as an additional option to the bootstrap process. For ``BOOTSTRAP_OPTS`` as an additional option to the bootstrap process. For
example, if you wish to set the bootstrap to re-partition a specific 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 secondary storage device (``/dev/sdb``), which will erase all of the data
device, then execute: on the device, then execute:
.. code-block:: shell-session .. 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_host_data_disk_device=sdb"
# export BOOTSTRAP_OPTS="${BOOTSTRAP_OPTS} bootstrap_host_ubuntu_repo=http://mymirror.example.com/ubuntu" # 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 You may wish to change the role fetch mode. Options are ``galaxy`` and
"git-clone". The default for this option is "galaxy". ``git-clone``. The default for this option is ``galaxy``.
options: options:
:galaxy: Resolve all role dependencies using the ``ansible-galaxy`` resolver :galaxy: Resolve all role dependencies using the ``ansible-galaxy`` resolver
@ -125,10 +125,10 @@ options:
Notes: Notes:
When doing role development it may be useful to set 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 ability to develop roles within the environment by modifying, patching, or
committing changes using an intact git tree while the *galaxy* option scrubs committing changes using an intact git tree while the ``galaxy`` option
the ``.git`` directory when it resolves a dependency. scrubs the ``.git`` directory when it resolves a dependency.
.. code-block:: bash .. 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 If you wish to add any additional configuration entries for the OpenStack
configuration then this can be done now by editing 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. for more details.
Finally, run the playbooks by executing: 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 that are not requested for deployment, but the service will not be deployed
in that container. in that container.
.. _Install Guide: ../install-guide/ .. _Deployment Guide: http://docs.openstack.org/project-deploy-guide/openstack-ansible/draft/
Rebooting an AIO 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 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. 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 Rebuilding an AIO
----------------- -----------------
@ -312,7 +312,3 @@ built for informational purposes only and should **ONLY** be used as such.
| | | | | | | | | | | | | |
| | V | | * | | | V | | * |
---->[ Compute ]*[ Neutron linuxbridge ]<---| |->[ Swift storage ]- ---->[ Compute ]*[ Neutron linuxbridge ]<---| |->[ Swift storage ]-
--------------
.. include:: navigation.txt

3
doc/source/developer-docs/role-services.rst
View File

@ -1,5 +1,4 @@
`Home <index.html>`_ OpenStack-Ansible Developer Documentation ==================
Roles and services Roles and services
================== ==================

7
doc/source/developer-docs/scripts.rst
View File

@ -1,5 +1,4 @@
`Home <index.html>`_ OpenStack-Ansible Developer Documentation ================
Included Scripts Included Scripts
================ ================
@ -231,7 +230,3 @@ following jobs:
While this script is primarily developed and maintained for use in While this script is primarily developed and maintained for use in
OpenStack-CI, it can be used in other environments. OpenStack-CI, it can be used in other environments.
--------------
.. include:: navigation.txt

4
doc/source/upgrade-guide/navigation.txt
View File

@ -1,4 +0,0 @@
* `Documentation Home <../index.html>`_
* `Installation Guide <http://docs.openstack.org/project-deploy-guide/openstack-ansible/draft/>`_
* `Upgrade Guide <index.html>`_
* `Developer Documentation <../developer-docs/index.html>`_