[Docs] Uniform landing text

When using the external links, we are sometimes referring with
the full link, sometimes with the macro. This standardizes to
use the proper macro links.

Change-Id: I9ce0df5d7d6348c5e0b01877ec259d36f9988067
This commit is contained in:
Jean-Philippe Evrard 2018-02-20 11:32:38 +00:00
parent ba7e064ef9
commit 134ec81016
5 changed files with 52 additions and 10 deletions

View File

@ -5,11 +5,19 @@ Operations Guide
This guide provides information about operating your OpenStack-Ansible This guide provides information about operating your OpenStack-Ansible
deployment. deployment.
For information how to deploy your OpenStack-Ansible cloud, refer to the For information on how to deploy your OpenStack-Ansible cloud, refer to the
`Deployment Guide <https://docs.openstack.org/project-deploy-guide/openstack-ansible/latest/>`_. :deploy_guide:`Deployment Guide <index.html>` for step-by-step
for step-by-step instructions on how to deploy the OpenStack packages and instructions on how to deploy the OpenStack packages and
dependencies on your cloud using OpenStack-Ansible. dependencies on your cloud using OpenStack-Ansible.
For user guides, see the :dev_docs:`User Guide <user/index.html>`.
For information on how to contribute, extend or develop OpenStack-Ansible,
see the :dev_docs:`Contributors Guide <contributor/index.html>`.
For in-depth technical information, see the
:dev_docs:`OpenStack-Ansible Reference <reference/index.html>`.
This guide ranges from first operations to verify your deployment, to This guide ranges from first operations to verify your deployment, to
the major upgrades procedures. the major upgrades procedures.

View File

@ -338,7 +338,7 @@ upgrade_backup_dir = "``/etc/openstack_deploy."+previous_release_capital_name+"`
# Used to reference the deploy guide # Used to reference the deploy guide
deploy_guide_prefix = "http://docs.openstack.org/project-deploy-guide/openstack-ansible/{}/%s".format(deploy_branch_link_name) deploy_guide_prefix = "http://docs.openstack.org/project-deploy-guide/openstack-ansible/{}/%s".format(deploy_branch_link_name)
dev_docs_prefix = "http://docs.openstack.org/openstack-ansible/{}%s".format(dev_branch_link_name) dev_docs_prefix = "http://docs.openstack.org/openstack-ansible/{}/%s".format(deploy_branch_link_name)
rst_epilog = """ rst_epilog = """
.. |previous_release_branch_name| replace:: %s .. |previous_release_branch_name| replace:: %s

View File

@ -5,8 +5,19 @@ Developer Documentation
In this section, you will find documentation relevant to developing In this section, you will find documentation relevant to developing
OpenStack-Ansible. OpenStack-Ansible.
For information on how to install and deploy OpenStack-Ansible, see the For information on how to deploy your OpenStack-Ansible cloud, refer to the
`Deployment Guide <https://docs.openstack.org/project-deploy-guide/openstack-ansible/latest/>`_. :deploy_guide:`Deployment Guide <index.html>` for step-by-step
instructions on how to deploy the OpenStack packages and
dependencies on your cloud using OpenStack-Ansible.
For user guides, see the :dev_docs:`User Guide <user/index.html>`.
For information on how to manage and operate OpenStack-Ansible, see the
see the :dev_docs:`Operations Guide <admin/index.html>`.
For in-depth technical information, see the
:dev_docs:`OpenStack-Ansible Reference <reference/index.html>`.
Contents: Contents:

View File

@ -5,6 +5,20 @@ OpenStack-Ansible Reference
This chapter contains all the extra reference information This chapter contains all the extra reference information
to deploy, configure, or upgrade an OpenStack-Ansible cloud. to deploy, configure, or upgrade an OpenStack-Ansible cloud.
For information on how to deploy your OpenStack-Ansible cloud, refer to the
:deploy_guide:`Deployment Guide <index.html>` for step-by-step
instructions on how to deploy the OpenStack packages and
dependencies on your cloud using OpenStack-Ansible.
For user guides, see the :dev_docs:`User Guide <user/index.html>`.
For information on how to manage and operate OpenStack-Ansible, see the
see the :dev_docs:`Operations Guide <admin/index.html>`.
For information on how to contribute, extend or develop OpenStack-Ansible,
see the :dev_docs:`Contributors Guide <contributor/index.html>`.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

View File

@ -2,10 +2,19 @@
User Guide User Guide
========== ==========
In this section, you will find user stories and examples relevant to
deploying OpenStack-Ansible.
For information on how to deploy your OpenStack-Ansible cloud, refer to the
:deploy_guide:`Deployment Guide <index.html>` for step-by-step
instructions on how to deploy the OpenStack packages and
dependencies on your cloud using OpenStack-Ansible.
.. toctree:: For information on how to manage and operate OpenStack-Ansible, see the
:maxdepth: 2 see the :dev_docs:`Operations Guide <admin/index.html>`.
manual-upgrade For information on how to contribute, extend or develop OpenStack-Ansible,
reference see the :dev_docs:`Contributors Guide <contributor/index.html>`.
For in-depth technical information, see the
:dev_docs:`OpenStack-Ansible Reference <reference/index.html>`.