openstack/openstack-ansible-os_ironic
Code Issues Proposed changes

[DOCS] Syntax updates to the docs

Browse Source 
Finish moving to new format, remove tags, fix RST titles, fix line
lengths, add link, indent example file, fresh coat of wax.

Change-Id: Ibcf3d5743c9b70d4f29ea8181d54a6c5c1974580
This commit is contained in:
Robb Romans 2016-08-24 16:35:52 -05:00 committed by Jesse Pretorius (odyssey4me)
parent d9e9eed948
commit ca416a4538
5 changed files with 93 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
CONTRIBUTING.rst
View File

@ -1,51 +1,59 @@
TEMPLATE
########
:tags: openstack, cloud, ansible
:category: \*nix
======================
Contributor guidelines
======================
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:
* The description clearly states or describes the original problem or root cause of the problem.
When submitting a bug, or working on a bug, please ensure the
following 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.
* 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.
Submitting Code
---------------
Submitting code
~~~~~~~~~~~~~~~
Changes to the project should be submitted for review via the Gerrit tool, following
the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow"
Changes to the project should be submitted for review via the Gerrit
tool, 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
-----
~~~~~
Tags:
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.
Tags: If it's a bug that needs fixing in a branch in addition to
Master, add a '\<release\>-backport-potential' tag (for example
``juno-backport-potential``). There are predefined tags that will
autocomplete.
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:
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
-----------
~~~~~~~~~~~
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, create them
using the YAML dictionary format.
Example YAML dictionary format:
.. code-block:: yaml
@ -69,17 +77,23 @@ Example **NOT** in YAML dictionary format:
- 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
------
~~~~~~
When submitting an issue, or working on an issue please ensure the following criteria are met:
* The description clearly states or describes the original problem or root cause of the problem.
When submitting an issue, or working on an issue, ensure the following
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.
* 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).
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
* 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).
* 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.
* Steps to reproduce the problem if possible.

30
README.rst
View File

@ -1,22 +1,12 @@
=================================
Ironic Role for OpenStack-Ansible
=================================
======================================================
OpenStack-Ansible role for Bare Metal (ironic) service
======================================================
This is a role for the deployment of Ironic in an `OpenStack-Ansible`_
environment.
Please see the `role-ironic spec`_ for more details.
.. _OpenStack-Ansible: https://github.com/openstack/openstack-ansible
.. _role-ironic spec: https://github.com/openstack/openstack-ansible-specs/blob/master/specs/mitaka/role-ironic.rst
Tags
====
This role supports two tags: ``ironic-install`` and ``ironic-config``
The ``ironic-install`` tag can be used to install and upgrade.
The ``ironic-config`` tag can be used to maintain configuration of the
This is an OpenStack-Ansible role to deploy the Bare Metal (ironic)
service.
Documentation for the project can be found at:
http://docs.openstack.org/developer/openstack-ansible-os_ironic
The project home is at:
http://launchpad.net/openstack-ansible

36
doc/source/index.rst
View File

@ -1,14 +1,42 @@
=================================
Ironic role for OpenStack-Ansible
=================================
======================================================
OpenStack-Ansible role for Bare Metal (ironic) service
======================================================
.. toctree::
:maxdepth: 2
configure-ironic.rst
Basic role example
This is an OpenStack-Ansible role to deploy the Bare Metal (ironic)
service. See the `role-ironic spec`_ for more information.
.. _role-ironic spec: https://github.com/openstack/openstack-ansible-specs/blob/master/specs/mitaka/role-ironic.rst
Default variables
~~~~~~~~~~~~~~~~~
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required variables
~~~~~~~~~~~~~~~~~~
None.
Example playbook
~~~~~~~~~~~~~~~~
.. literalinclude:: ../../examples/playbook.yml
:language: yaml
Tags
====
This role supports the ``ironic-install`` and ``ironic-config`` tags.
Use the ``ironic-install`` tag to install and upgrade. Use the
``ironic-config`` tag to maintain configuration of the service.

10
examples/playbook.yml
View File

@ -1,5 +1,5 @@
- name: Playbook for role testing
hosts: localhost
remote_user: root
roles:
- role: openstack-ansible-ironic
- name: Playbook for role testing
hosts: localhost
remote_user: root
roles:
- role: openstack-ansible-os_ironic

2
setup.cfg
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_ironic
classifier =
Intended Audience :: Developers
Intended Audience :: System Administrators