openstack/openstack-ansible-os_glance
Code Issues Proposed changes

[DOCS] Cleanup the role docs for consistency and clarity

Browse Source 
Change-Id: I4cc524151c6372842cdc83f9838df24d0743f91b
This commit is contained in:
Travis Truman 2016-03-07 17:03:49 -05:00
parent f4454345f6
commit dd622f8683
3 changed files with 39 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
CONTRIBUTING.rst
View File

@ -1,5 +1,5 @@
OpenStack glance OpenStack-Ansible Glance
################ ########################
:tags: openstack, glance, cloud, ansible :tags: openstack, glance, cloud, ansible
:category: \*nix :category: \*nix
@ -9,43 +9,53 @@ contributor guidelines
Filing Bugs Filing Bugs
----------- -----------
Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net/openstack-ansible" Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net
/openstack-ansible"
When submitting a bug, or working on a bug, please ensure the following criteria are met: When submitting a bug, or working on a bug, please ensure the following
* The description clearly states or describes the original problem or root cause of the problem. criteria are met:
* The description clearly states or describes the original problem or root
cause of the problem.
* Include historical information on how the problem was identified. * Include historical information on how the problem was identified.
* Any relevant logs are included. * Any relevant logs are included.
* The provided information should be totally self-contained. External access to web services/sites should not be needed. * The provided information should be totally self-contained. External
access to web services/sites should not be needed.
* Steps to reproduce the problem if possible. * Steps to reproduce the problem if possible.
Submitting Code Submitting Code
--------------- ---------------
Changes to the project should be submitted for review via the Gerrit tool, following Changes to the project should be submitted for review via the Gerrit tool,
the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow" following the workflow documented at:
"http://docs.openstack.org/infra/manual/developers.html#development-workflow"
Pull requests submitted through GitHub will be ignored and closed without regard. Pull requests submitted through GitHub will be ignored and closed without
regard.
Extra Extra
----- -----
Tags: Tags: If it's a bug that needs fixing in a branch in addition to Master, add a
If it's a bug that needs fixing in a branch in addition to Master, add a '\<release\>-backport-potential' tag (eg ``juno-backport-potential``). There are predefined tags that will autocomplete. '\<release\>-backport-potential' tag (eg ``juno-backport-potential``).
There are predefined tags that will autocomplete.
Status: Status:
Please leave this alone, it should be New till someone triages the issue. Please leave this alone, it should be New till someone triages the issue.
Importance: Importance:
Should only be touched if it is a Blocker/Gating issue. If it is, please set to High, and only use Critical if you have found a bug that can take down whole infrastructures. Should only be touched if it is a Blocker/Gating issue. If it is, please
set to High, and only use Critical if you have found a bug that can take
down whole infrastructures.
Style guide Style guide
----------- -----------
When creating tasks and other roles for use in Ansible please create then using the YAML dictionary format. When creating tasks and other roles for use in Ansible please create then
using the YAML dictionary format.
Example YAML dictionary format: Example YAML dictionary format:
.. code-block:: yaml .. code-block:: yaml
@ -69,17 +79,22 @@ Example **NOT** in YAML dictionary format:
- some-other-tag - some-other-tag
Usage of the ">" and "|" operators should be limited to Ansible conditionals and command modules such as the ansible ``shell`` module. Usage of the ">" and "|" operators should be limited to Ansible conditionals
and command modules such as the ansible ``shell`` module.
Issues Issues
------ ------
When submitting an issue, or working on an issue please ensure the following criteria are met: When submitting an issue, or working on an issue please ensure the following
* The description clearly states or describes the original problem or root cause of the problem. criteria are met:
* The description clearly states or describes the original problem or root
cause of the problem.
* Include historical information on how the problem was identified. * Include historical information on how the problem was identified.
* Any relevant logs are included. * Any relevant logs are included.
* If the issue is a bug that needs fixing in a branch other than Master, add the ‘backport potential’ tag TO THE ISSUE (not the PR). * If the issue is a bug that needs fixing in a branch other than Master,
* The provided information should be totally self-contained. External access to web services/sites should not be needed. add the ‘backport potential’ tag TO THE ISSUE (not the PR).
* The provided information should be totally self-contained. External
access to web services/sites should not be needed.
* If the issue is needed for a hotfix release, add the 'expedite' label. * If the issue is needed for a hotfix release, add the 'expedite' label.
* Steps to reproduce the problem if possible. * Steps to reproduce the problem if possible.

9
README.rst
View File

@ -1,11 +1,12 @@
OpenStack glance OpenStack-Ansible Glance
################ ########################
:tags: openstack, glance, cloud, ansible :tags: openstack, glance, cloud, ansible
:category: \*nix :category: \*nix
Role to install glance and glance registry. This Ansible role installs and configures OpenStack glance and glance
registry.
This role will install the following: This role will install the following Upstart services:
* glance-api * glance-api
* glance-registry * glance-registry

15
doc/source/index.rst
View File

@ -1,14 +1 @@
os_glance Docs .. include:: ../../README.rst
==============
Role to install glance and glance registry.
Basic Role Example
^^^^^^^^^^^^^^^^^^
Tell us how to use the role.
.. code-block:: yaml
- role: "os_glance"
ROLE_VARS...