diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index e12a1f8f7b..72fae7c9ea 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -5,11 +5,19 @@ Operations Guide This guide provides information about operating your OpenStack-Ansible deployment. -For information how to deploy your OpenStack-Ansible cloud, refer to the -`Deployment Guide `_. -for step-by-step instructions on how to deploy the OpenStack packages and +For information on how to deploy your OpenStack-Ansible cloud, refer to the +:deploy_guide:`Deployment Guide ` 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 `. + +For information on how to contribute, extend or develop OpenStack-Ansible, +see the :dev_docs:`Contributors Guide `. + +For in-depth technical information, see the +:dev_docs:`OpenStack-Ansible Reference `. + This guide ranges from first operations to verify your deployment, to the major upgrades procedures. diff --git a/doc/source/conf.py b/doc/source/conf.py index 9b6555ccba..a5020c4608 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -338,7 +338,7 @@ upgrade_backup_dir = "``/etc/openstack_deploy."+previous_release_capital_name+"` # Used to reference the deploy guide 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 = """ .. |previous_release_branch_name| replace:: %s diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 00cb05931c..d2078581be 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -5,8 +5,19 @@ Developer Documentation In this section, you will find documentation relevant to developing OpenStack-Ansible. -For information on how to install and deploy OpenStack-Ansible, see the -`Deployment Guide `_. +For information on how to deploy your OpenStack-Ansible cloud, refer to the +:deploy_guide:`Deployment Guide ` 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 `. + +For information on how to manage and operate OpenStack-Ansible, see the +see the :dev_docs:`Operations Guide `. + +For in-depth technical information, see the +:dev_docs:`OpenStack-Ansible Reference `. + Contents: diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 193c61bf1c..60e7f06cfb 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -5,6 +5,20 @@ OpenStack-Ansible Reference This chapter contains all the extra reference information 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 ` 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 `. + +For information on how to manage and operate OpenStack-Ansible, see the +see the :dev_docs:`Operations Guide `. + +For information on how to contribute, extend or develop OpenStack-Ansible, +see the :dev_docs:`Contributors Guide `. + + .. toctree:: :maxdepth: 1 diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 642d0bb5f7..7249523031 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -2,10 +2,19 @@ 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 ` for step-by-step +instructions on how to deploy the OpenStack packages and +dependencies on your cloud using OpenStack-Ansible. -.. toctree:: - :maxdepth: 2 +For information on how to manage and operate OpenStack-Ansible, see the +see the :dev_docs:`Operations Guide `. - manual-upgrade - reference +For information on how to contribute, extend or develop OpenStack-Ansible, +see the :dev_docs:`Contributors Guide `. + +For in-depth technical information, see the +:dev_docs:`OpenStack-Ansible Reference `.