From ef70b6f64a478606b2d2757ce6c206a8662ceb65 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/Pike Change-Id: I098801b25e8c390b4157a57596431ed4b78e3a38 --- README.rst | 2 +- deploy-guide/source/conf.py | 4 ++-- doc/source/conf.py | 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 | 6 +++--- doc/source/upgrade-guide/overview.rst | 2 +- doc/source/upgrade-guide/script-upgrade.rst | 2 +- 9 files changed, 17 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index 7af1616668..3095485149 100644 --- a/README.rst +++ b/README.rst @@ -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 -.. _Deployment Guide: https://docs.openstack.org/project-deploy-guide/openstack-ansible/ocata/ +.. _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/deploy-guide/source/conf.py b/deploy-guide/source/conf.py index a5f56acd65..3c61e74d4d 100644 --- a/deploy-guide/source/conf.py +++ b/deploy-guide/source/conf.py @@ -301,8 +301,8 @@ pdf_documents = [ latest_tag = os.popen('git describe --abbrev=0 --tags').read().strip('\n') -previous_release_branch_name='newton' -current_release_branch_name='ocata' +previous_release_branch_name='ocata' +current_release_branch_name='pike' # Var specifically for using in URLs; differs because it might be 'draft' # on master for deploy guide deploy_branch_link_name = current_release_branch_name diff --git a/doc/source/conf.py b/doc/source/conf.py index 7079ab9cf9..aa974500d4 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -301,8 +301,8 @@ pdf_documents = [ latest_tag = os.popen('git describe --abbrev=0 --tags').read().strip('\n') -previous_release_branch_name='newton' -current_release_branch_name='ocata' +previous_release_branch_name='ocata' +current_release_branch_name='pike' # Var specifically for using in URLs; differs because it might be 'draft' # on master for deploy guide deploy_branch_link_name = current_release_branch_name diff --git a/doc/source/developer-docs/additional-roles.rst b/doc/source/developer-docs/additional-roles.rst index 5e7d53fda6..47e726bd12 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 c6de5edf31..b6a4f35f86 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 @@ -175,7 +176,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 200b4deaf6..e116c9776b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -25,14 +25,14 @@ OpenStack-Ansible Pike is currently in development. developer-docs/index inventory/index -.. _Deployment Guide: http://docs.openstack.org/project-deploy-guide/draft/ +.. _Deployment Guide: http://docs.openstack.org/project-deploy-guide/openstack-ansible/draft/ .. _Release Notes: http://docs.openstack.org/releasenotes/openstack-ansible/unreleased.html Ocata: Release Candidate ~~~~~~~~~~~~~~~~~~~~~~~~ -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. * `OpenStack-Ansible Ocata Documentation`_ 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