[DOCS] - Clean up role docs

Changes are:
 - README now links to role docs and project launchpad
 - Project homepage links to developer docs
 - Service capitalization fixed
 - Example playbook indentation fixed

Change-Id: I40b20c48cc15d516d949be51aa55597a4d77a421
This commit is contained in:
Travis Truman 2016-08-17 10:56:38 -04:00
parent ba067d46be
commit 88416a9760
4 changed files with 23 additions and 20 deletions

View File

@ -2,17 +2,11 @@
OpenStack-Ansible cinder
========================
This Ansible role installs and configures OpenStack Cinder.
This Ansible role installs and configures OpenStack cinder.
The following Cinder services are managed by the role:
* cinder-api
* cinder-volume
* cinder-scheduler
Documentation for the project can be found at:
http://docs.openstack.org/developer/openstack-ansible-os_cinder/
By default, Cinder API v1 and v2 are both enabled.
The project home is at:
http://launchpad.net/openstack-ansible
Support for various Cinder backends is supported by the role. See role
internals for further details.
Support for volume backups to Swift or Ceph is supported by the role. See role
internals for further details.

View File

@ -2,6 +2,15 @@
Cinder role for OpenStack-Ansible
=================================
This Ansible role installs and configures OpenStack cinder.
The following cinder services are managed by the role:
* cinder-api
* cinder-volume
* cinder-scheduler
By default, cinder API v1 and v2 are both enabled.
.. toctree::
:maxdepth: 2

View File

@ -1,4 +1,4 @@
- name: Installation and setup of cinder
- name: Installation and setup of cinder
hosts: cinder_all
user: root
roles:

View File

@ -5,7 +5,7 @@ description-file =
README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
home-page = http://www.openstack.org/
home-page = http://docs.openstack.org/developer/openstack-ansible-os_cinder/
classifier =
Intended Audience :: Developers
Intended Audience :: System Administrators