From 15e2f3f314c32e75d0781aec7c063a104594bc4d Mon Sep 17 00:00:00 2001 From: Jesse Pretorius Date: Wed, 8 Mar 2017 16:48:45 +0000 Subject: [PATCH] [docs] Update doc references for Ocata Backport notes: Ocata/Pike references have been adjusted to suit the Ocata branch. Some changes from the master branch have therefore not been ported back. All developer docs are set to point to the latest deploy guide rather than the Ocata deploy guide. This is more maintainable and the latest stable reference is better for development work. Change-Id: I098801b25e8c390b4157a57596431ed4b78e3a38 (cherry picked from commit ef70b6f64a478606b2d2757ce6c206a8662ceb65) --- README.rst | 4 ++-- doc/source/developer-docs/additional-roles.rst | 3 ++- doc/source/developer-docs/contribute.rst | 2 +- doc/source/draft-operations-guide/advanced-config.rst | 7 ++++--- doc/source/index.rst | 4 ++-- doc/source/upgrade-guide/overview.rst | 2 +- doc/source/upgrade-guide/script-upgrade.rst | 2 +- 7 files changed, 13 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 8f0bfe538e..3095485149 100644 --- a/README.rst +++ b/README.rst @@ -21,7 +21,7 @@ For those looking to test OpenStack-Ansible using an All-In-One (AIO) build, please see the `Quick Start`_ guide. For more detailed Installation and Operator documentation, please see the -`Install Guide`_. +`Deployment Guide`_. If OpenStack-Ansible is missing something you'd like to see included, then we encourage you to see the `Developer Documentation`_ for more details on @@ -48,7 +48,7 @@ http://git.openstack.org/cgit/openstack/openstack-ansible-. .. _official OpenStack project: http://governance.openstack.org/reference/projects/index.html .. _Home Page: http://governance.openstack.org/reference/projects/openstackansible.html -.. _Install Guide: http://docs.openstack.org/developer/openstack-ansible/install-guide/index.html +.. _Deployment Guide: https://docs.openstack.org/project-deploy-guide/openstack-ansible .. _Quick Start: http://docs.openstack.org/developer/openstack-ansible/developer-docs/quickstart-aio.html .. _Developer Documentation: http://docs.openstack.org/developer/openstack-ansible/developer-docs/index.html .. _Source: http://git.openstack.org/cgit/openstack/openstack-ansible diff --git a/doc/source/developer-docs/additional-roles.rst b/doc/source/developer-docs/additional-roles.rst index a75731d6f0..3e493a757e 100644 --- a/doc/source/developer-docs/additional-roles.rst +++ b/doc/source/developer-docs/additional-roles.rst @@ -97,7 +97,8 @@ Deploying the Role modifications being sure that group labels in ``env.d`` and ``conf.d`` files are consistent. -#. Generate secrets, if any, as described in the `Deployment Guide `_. +#. Generate secrets, if any, as described in the :deploy_guide:`Configure + Service Credentials `. You can append your keys to an existing ``user_secrets.yml`` file or add a new file to the ``openstack_deploy`` directory to contain them. Provide overrides for any other variables you will need at this time as well, either diff --git a/doc/source/developer-docs/contribute.rst b/doc/source/developer-docs/contribute.rst index 04253171f4..228d48d69a 100644 --- a/doc/source/developer-docs/contribute.rst +++ b/doc/source/developer-docs/contribute.rst @@ -195,7 +195,7 @@ OpenStack-Ansible has multiple forms of documentation with different intent. statements of intent. The work to fulfill the intent is ongoing. Any new documentation submissions should try to help this intent where possible. -The `Deployment Guide `_ +The `Deployment Guide `_ intends to help deployers deploy OpenStack-Ansible for the first time. The role documentation (for example, the `keystone role documentation`_) diff --git a/doc/source/draft-operations-guide/advanced-config.rst b/doc/source/draft-operations-guide/advanced-config.rst index 786faa6ebd..466be2025f 100644 --- a/doc/source/draft-operations-guide/advanced-config.rst +++ b/doc/source/draft-operations-guide/advanced-config.rst @@ -112,7 +112,8 @@ deployed environment, allowing a deployer to define additional group mappings. This directory is used to extend the environment skeleton, or modify the defaults defined in the ``playbooks/inventory/env.d`` directory. -See also `Understanding Container Groups `_ +See also +:deploy_guide:`Understanding Container Groups ` in Appendix C of the Deployment Guide. conf.d @@ -125,7 +126,7 @@ OpenStack-Ansible in the Additional services should be defined with a YAML file in ``/etc/openstack_deploy/conf.d``, in order to manage file size. -See also `Understanding Host Groups `_ +See also :deploy_guide:`Understanding Host Groups ` in Appendix C of the Deployment Guide. user_*.yml files @@ -172,7 +173,7 @@ functionality where applicable. Files available to receive overrides can be seen in the ``defaults/main.yml`` file as standard empty dictionaries (hashes). Practical guidance for using this feature is available in the -`Deployment Guide `_. +:deploy_guide:`Deployment Guide `. This module has been `submitted for consideration`_ into Ansible Core. diff --git a/doc/source/index.rst b/doc/source/index.rst index ef95dc5a8b..0b23d29da0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,8 +5,8 @@ OpenStack-Ansible Documentation OpenStack-Ansible provides Ansible playbooks and roles for the deployment and configuration of an OpenStack environment. -OpenStack-Ansible's Ocata series is scheduled to be released with the 15.0.0 -tag by 10 Mar 2017. +OpenStack-Ansible's Ocata series was first released with the 15.0.0 tag on +8 March 2017. * `Ocata Series Release Notes`_ * `OpenStack-Ansible Ocata Deployment Guide`_ diff --git a/doc/source/upgrade-guide/overview.rst b/doc/source/upgrade-guide/overview.rst index b02861a52b..6f2c2d88dc 100644 --- a/doc/source/upgrade-guide/overview.rst +++ b/doc/source/upgrade-guide/overview.rst @@ -27,4 +27,4 @@ major upgrade process performs the following actions: - Upgrades the RabbitMQ server. See :ref:`setup-infra-playbook` for details. For more information about the major upgrade process, see -:ref:`` and :ref:`Upgrading-manually`. +:ref:`upgrading-by-using-a-script` and :ref:`upgrading-manually`. diff --git a/doc/source/upgrade-guide/script-upgrade.rst b/doc/source/upgrade-guide/script-upgrade.rst index 1a46f6fd30..e6a4bdcc1b 100644 --- a/doc/source/upgrade-guide/script-upgrade.rst +++ b/doc/source/upgrade-guide/script-upgrade.rst @@ -1,4 +1,4 @@ -.. _Upgrading-by-using-a-script: +.. _upgrading-by-using-a-script: =========================== Upgrading by using a script