From 92ccc1b8cda9c31c39a375fffe20561d24340745 Mon Sep 17 00:00:00 2001 From: Jimmy McCrory Date: Tue, 14 Feb 2017 02:15:40 -0800 Subject: [PATCH] [DOCS] Include branch in links to role docs Create a new external link alias for role docs to simplify adding links for them within the deploy guide and to automatically include the correct branch name within those links. Closes-Bug: 1620233 Change-Id: I02a474fabe5c1a7499e828c4661cf6b232886409 --- deploy-guide/source/conf.py | 4 +- deploy-guide/source/configure.rst | 102 +++++++++++------------------- 2 files changed, 39 insertions(+), 67 deletions(-) diff --git a/deploy-guide/source/conf.py b/deploy-guide/source/conf.py index 847a0324bc..a5f56acd65 100644 --- a/deploy-guide/source/conf.py +++ b/deploy-guide/source/conf.py @@ -341,9 +341,11 @@ if watermark == "": 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/developer/openstack-ansible/developer-docs/{}%s".format(dev_branch_link_name) +role_docs_prefix = "http://docs.openstack.org/developer/openstack-ansible-%s/{}".format(dev_branch_link_name) extlinks = {'deploy_guide': (deploy_guide_prefix, ''), - 'dev_docs': (dev_docs_prefix, '') + 'dev_docs': (dev_docs_prefix, ''), + 'role_docs': (role_docs_prefix, '') } # -- Options for sphinxmark ----------------------------------------------- diff --git a/deploy-guide/source/configure.rst b/deploy-guide/source/configure.rst index 1cf4161523..70763e2fdf 100644 --- a/deploy-guide/source/configure.rst +++ b/deploy-guide/source/configure.rst @@ -74,115 +74,85 @@ about the available options. Infrastructure service roles ---------------------------- -- `galera_server - `_ +- :role_docs:`galera_server` -- `haproxy_server - `_ +- :role_docs:`haproxy_server` -- `memcached_server - `_ +- :role_docs:`memcached_server` -- `rabbitmq_server - `_ +- :role_docs:`rabbitmq_server` -- `repo_build - `_ +- :role_docs:`repo_build` -- `repo_server - `_ +- :role_docs:`repo_server` -- `rsyslog_server - `_ +- :role_docs:`rsyslog_server` OpenStack service roles ----------------------- -- `os_aodh `_ +- :role_docs:`os_aodh` -- `os_barbican - `_ +- :role_docs:`os_barbican` -- `os_ceilometer - `_ +- :role_docs:`os_ceilometer` -- `os_cinder - `_ +- :role_docs:`os_cinder` -- `os_designate - `_ +- :role_docs:`os_designate` -- `os_glance - `_ +- :role_docs:`os_glance` -- `os_gnocchi - `_ +- :role_docs:`os_gnocchi` -- `os_heat `_ +- :role_docs:`os_heat` -- `os_horizon - `_ +- :role_docs:`os_horizon` -- `os_ironic - `_ +- :role_docs:`os_ironic` -- `os_keystone - `_ +- :role_docs:`os_keystone` -- `os_magnum - `_ +- :role_docs:`os_magnum` -- `os_neutron - `_ +- :role_docs:`os_neutron` -- `os_nova `_ +- :role_docs:`os_nova` -- `os_rally `_ +- :role_docs:`os_rally` -- `os_sahara - `_ +- :role_docs:`os_sahara` -- `os_swift `_ +- :role_docs:`os_swift` -- `os_tempest - `_ +- :role_docs:`os_tempest` -- `os_trove `_ +- :role_docs:`os_trove` Other roles ----------- -- `ansible-plugins - `_ +- :role_docs:`ansible-plugins` -- `apt_package_pinning - `_ +- :role_docs:`apt_package_pinning` -- `ceph_client - `_ +- :role_docs:`ceph_client` -- `galera_client - `_ +- :role_docs:`galera_client` -- `lxc_container_create - `_ +- :role_docs:`lxc_container_create` -- `lxc_hosts - `_ +- :role_docs:`lxc_hosts` -- `pip_install - `_ +- :role_docs:`pip_install` -- `openstack_openrc - `_ +- :role_docs:`openstack_openrc` -- `openstack_hosts - `_ +- :role_docs:`openstack_hosts` -- `rsyslog_client - `_ +- :role_docs:`rsyslog_client` Configuring service credentials ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~