From c06bf31585b9b409f7a84deba1909f6e77b820aa Mon Sep 17 00:00:00 2001
From: Alexandra Settle <alexandra.settle@rackspace.com>
Date: Wed, 30 Nov 2016 13:36:29 +0000
Subject: [PATCH] [DOCS] Adding new roles and services section

Adding list of role docs to developer documentation for ease of use

Change-Id: I906fd7112ba62a1d1f00ce1d6d5d9317db66e976
---
 .../source/app-advanced-role-docs.rst         | 87 +----------------
 .../developer-docs/advanced-role-docs.rst     | 94 +++++++++++++++++++
 doc/source/developer-docs/index.rst           |  2 +-
 doc/source/developer-docs/role-services.rst   | 15 +++
 4 files changed, 112 insertions(+), 86 deletions(-)
 create mode 100644 doc/source/developer-docs/advanced-role-docs.rst
 create mode 100644 doc/source/developer-docs/role-services.rst

diff --git a/deploy-guide/source/app-advanced-role-docs.rst b/deploy-guide/source/app-advanced-role-docs.rst
index 7fd55b737d..0c68f5a065 100644
--- a/deploy-guide/source/app-advanced-role-docs.rst
+++ b/deploy-guide/source/app-advanced-role-docs.rst
@@ -1,5 +1,3 @@
-.. _role-docs:
-
 ==============================
 Advanced service configuration
 ==============================
@@ -8,87 +6,6 @@ OpenStack-Ansible has many options that you can use for the advanced
 configuration of services. Each role's documentation provides information
 about the available options.
 
-The following options are optional.
+You can find the list of advanced service configuration roles OpenStack-Ansible
+supports in the `Developer documentation <http://docs.openstack.org/developer/openstack-ansible/developer-docs/index.html>`_.
 
-Infrastructure service roles
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-- `galera_server <http://docs.openstack.org/developer/openstack-ansible-galera_server>`_
-
-- `haproxy_server <http://docs.openstack.org/developer/openstack-ansible-haproxy_server>`_
-
-- `memcached_server <http://docs.openstack.org/developer/openstack-ansible-memcached_server>`_
-
-- `rabbitmq_server <http://docs.openstack.org/developer/openstack-ansible-rabbitmq_server>`_
-
-- `repo_build <http://docs.openstack.org/developer/openstack-ansible-repo_build>`_
-
-- `repo_server <http://docs.openstack.org/developer/openstack-ansible-repo_server>`_
-
-- `rsyslog_server <http://docs.openstack.org/developer/openstack-ansible-rsyslog_server>`_
-
-
-OpenStack service roles
-~~~~~~~~~~~~~~~~~~~~~~~
-
--  `os_aodh <http://docs.openstack.org/developer/openstack-ansible-os_aodh>`_
-
--  `os_barbican <http://docs.openstack.org/developer/openstack-ansible-os_barbican>`_
-
--  `os_ceilometer <http://docs.openstack.org/developer/openstack-ansible-os_ceilometer>`_
-
--  `os_cinder <http://docs.openstack.org/developer/openstack-ansible-os_cinder>`_
-
--  `os_designate <http://docs.openstack.org/developer/openstack-ansible-os_designate>`_
-
--  `os_glance <http://docs.openstack.org/developer/openstack-ansible-os_glance>`_
-
--  `os_gnocchi <http://docs.openstack.org/developer/openstack-ansible-os_gnocchi>`_
-
--  `os_heat <http://docs.openstack.org/developer/openstack-ansible-os_heat>`_
-
--  `os_horizon <http://docs.openstack.org/developer/openstack-ansible-os_horizon>`_
-
--  `os_ironic <http://docs.openstack.org/developer/openstack-ansible-os_ironic>`_
-
--  `os_keystone <http://docs.openstack.org/developer/openstack-ansible-os_keystone>`_
-
--  `os_magnum <http://docs.openstack.org/developer/openstack-ansible-os_magnum>`_
-
--  `os_neutron <http://docs.openstack.org/developer/openstack-ansible-os_neutron>`_
-
--  `os_nova <http://docs.openstack.org/developer/openstack-ansible-os_nova>`_
-
--  `os_rally <http://docs.openstack.org/developer/openstack-ansible-os_rally>`_
-
--  `os_sahara <http://docs.openstack.org/developer/openstack-ansible-os_sahara>`_
-
--  `os_swift <http://docs.openstack.org/developer/openstack-ansible-os_swift>`_
-
--  `os_tempest <http://docs.openstack.org/developer/openstack-ansible-os_tempest>`_
-
--  `os_trove <http://docs.openstack.org/developer/openstack-ansible-os_trove>`_
-
-
-Other roles
-~~~~~~~~~~~
-
-- `ansible-plugins <http://docs.openstack.org/developer/openstack-ansible-plugins>`_
-
-- `apt_package_pinning <http://docs.openstack.org/developer/openstack-ansible-apt_package_pinning/>`_
-
-- `ceph_client <http://docs.openstack.org/developer/openstack-ansible-ceph_client>`_
-
-- `galera_client <http://docs.openstack.org/developer/openstack-ansible-galera_client>`_
-
-- `lxc_container_create <http://docs.openstack.org/developer/openstack-ansible-lxc_container_create>`_
-
-- `lxc_hosts <http://docs.openstack.org/developer/openstack-ansible-lxc_hosts>`_
-
-- `pip_install <http://docs.openstack.org/developer/openstack-ansible-pip_install/>`_
-
-- `openstack_openrc <http://docs.openstack.org/developer/openstack-ansible-openstack_openrc>`_
-
-- `openstack_hosts <http://docs.openstack.org/developer/openstack-ansible-openstack_hosts>`_
-
-- `rsyslog_client <http://docs.openstack.org/developer/openstack-ansible-rsyslog_client>`_
diff --git a/doc/source/developer-docs/advanced-role-docs.rst b/doc/source/developer-docs/advanced-role-docs.rst
new file mode 100644
index 0000000000..7fd55b737d
--- /dev/null
+++ b/doc/source/developer-docs/advanced-role-docs.rst
@@ -0,0 +1,94 @@
+.. _role-docs:
+
+==============================
+Advanced service configuration
+==============================
+
+OpenStack-Ansible has many options that you can use for the advanced
+configuration of services. Each role's documentation provides information
+about the available options.
+
+The following options are optional.
+
+Infrastructure service roles
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- `galera_server <http://docs.openstack.org/developer/openstack-ansible-galera_server>`_
+
+- `haproxy_server <http://docs.openstack.org/developer/openstack-ansible-haproxy_server>`_
+
+- `memcached_server <http://docs.openstack.org/developer/openstack-ansible-memcached_server>`_
+
+- `rabbitmq_server <http://docs.openstack.org/developer/openstack-ansible-rabbitmq_server>`_
+
+- `repo_build <http://docs.openstack.org/developer/openstack-ansible-repo_build>`_
+
+- `repo_server <http://docs.openstack.org/developer/openstack-ansible-repo_server>`_
+
+- `rsyslog_server <http://docs.openstack.org/developer/openstack-ansible-rsyslog_server>`_
+
+
+OpenStack service roles
+~~~~~~~~~~~~~~~~~~~~~~~
+
+-  `os_aodh <http://docs.openstack.org/developer/openstack-ansible-os_aodh>`_
+
+-  `os_barbican <http://docs.openstack.org/developer/openstack-ansible-os_barbican>`_
+
+-  `os_ceilometer <http://docs.openstack.org/developer/openstack-ansible-os_ceilometer>`_
+
+-  `os_cinder <http://docs.openstack.org/developer/openstack-ansible-os_cinder>`_
+
+-  `os_designate <http://docs.openstack.org/developer/openstack-ansible-os_designate>`_
+
+-  `os_glance <http://docs.openstack.org/developer/openstack-ansible-os_glance>`_
+
+-  `os_gnocchi <http://docs.openstack.org/developer/openstack-ansible-os_gnocchi>`_
+
+-  `os_heat <http://docs.openstack.org/developer/openstack-ansible-os_heat>`_
+
+-  `os_horizon <http://docs.openstack.org/developer/openstack-ansible-os_horizon>`_
+
+-  `os_ironic <http://docs.openstack.org/developer/openstack-ansible-os_ironic>`_
+
+-  `os_keystone <http://docs.openstack.org/developer/openstack-ansible-os_keystone>`_
+
+-  `os_magnum <http://docs.openstack.org/developer/openstack-ansible-os_magnum>`_
+
+-  `os_neutron <http://docs.openstack.org/developer/openstack-ansible-os_neutron>`_
+
+-  `os_nova <http://docs.openstack.org/developer/openstack-ansible-os_nova>`_
+
+-  `os_rally <http://docs.openstack.org/developer/openstack-ansible-os_rally>`_
+
+-  `os_sahara <http://docs.openstack.org/developer/openstack-ansible-os_sahara>`_
+
+-  `os_swift <http://docs.openstack.org/developer/openstack-ansible-os_swift>`_
+
+-  `os_tempest <http://docs.openstack.org/developer/openstack-ansible-os_tempest>`_
+
+-  `os_trove <http://docs.openstack.org/developer/openstack-ansible-os_trove>`_
+
+
+Other roles
+~~~~~~~~~~~
+
+- `ansible-plugins <http://docs.openstack.org/developer/openstack-ansible-plugins>`_
+
+- `apt_package_pinning <http://docs.openstack.org/developer/openstack-ansible-apt_package_pinning/>`_
+
+- `ceph_client <http://docs.openstack.org/developer/openstack-ansible-ceph_client>`_
+
+- `galera_client <http://docs.openstack.org/developer/openstack-ansible-galera_client>`_
+
+- `lxc_container_create <http://docs.openstack.org/developer/openstack-ansible-lxc_container_create>`_
+
+- `lxc_hosts <http://docs.openstack.org/developer/openstack-ansible-lxc_hosts>`_
+
+- `pip_install <http://docs.openstack.org/developer/openstack-ansible-pip_install/>`_
+
+- `openstack_openrc <http://docs.openstack.org/developer/openstack-ansible-openstack_openrc>`_
+
+- `openstack_hosts <http://docs.openstack.org/developer/openstack-ansible-openstack_hosts>`_
+
+- `rsyslog_client <http://docs.openstack.org/developer/openstack-ansible-rsyslog_client>`_
diff --git a/doc/source/developer-docs/index.rst b/doc/source/developer-docs/index.rst
index 5573f798d1..de2053eec4 100644
--- a/doc/source/developer-docs/index.rst
+++ b/doc/source/developer-docs/index.rst
@@ -18,5 +18,5 @@ Contents:
    contribute
    bug-triage
    core-reviewers
-   additional-roles
+   role-services
    inventory
diff --git a/doc/source/developer-docs/role-services.rst b/doc/source/developer-docs/role-services.rst
new file mode 100644
index 0000000000..872b1874ee
--- /dev/null
+++ b/doc/source/developer-docs/role-services.rst
@@ -0,0 +1,15 @@
+`Home <index.html>`_ OpenStack-Ansible Developer Documentation
+
+Roles and services
+==================
+
+If you would like to contribute towards a role to introduce an OpenStack
+service or an infrastructure service to support an OpenStack deployment, the
+OpenStack-Ansible project would welcome that contribution and your assistance
+in maintaining it.
+
+.. toctree::
+   :maxdepth: 2
+
+   additional-roles
+   advanced-role-docs