[DOCS] Syntax updates to the docs
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
Jesse Pretorius (odyssey4me)
parent
d9e9eed948
commit
ca416a4538
|
|
@ -1,51 +1,59 @@
|
||||||
TEMPLATE
|
======================
|
||||||
########
|
Contributor guidelines
|
||||||
:tags: openstack, cloud, ansible
|
======================
|
||||||
:category: \*nix
|
|
||||||
|
|
||||||
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
|
||||||
* The description clearly states or describes the original problem or root cause of the problem.
|
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.
|
* 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
|
||||||
the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow"
|
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
|
Extra
|
||||||
-----
|
~~~~~
|
||||||
|
|
||||||
Tags:
|
Tags: If it's a bug that needs fixing in a branch in addition to
|
||||||
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.
|
Master, add a '\<release\>-backport-potential' tag (for example
|
||||||
|
``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, create them
|
||||||
|
using the YAML dictionary format.
|
||||||
|
|
||||||
Example YAML dictionary format:
|
Example YAML dictionary format:
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
@ -69,17 +77,23 @@ 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, 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
|
||||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
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.
|
* 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.
|
||||||
|
|
|
||||||
30
README.rst
30
README.rst
|
|
@ -1,22 +1,12 @@
|
||||||
=================================
|
======================================================
|
||||||
Ironic Role for OpenStack-Ansible
|
OpenStack-Ansible role for Bare Metal (ironic) service
|
||||||
=================================
|
======================================================
|
||||||
|
|
||||||
|
This is an OpenStack-Ansible role to deploy the Bare Metal (ironic)
|
||||||
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
|
|
||||||
service.
|
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
|
||||||
|
|
|
||||||
|
|
@ -1,14 +1,42 @@
|
||||||
=================================
|
======================================================
|
||||||
Ironic role for OpenStack-Ansible
|
OpenStack-Ansible role for Bare Metal (ironic) service
|
||||||
=================================
|
======================================================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
configure-ironic.rst
|
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
|
.. literalinclude:: ../../examples/playbook.yml
|
||||||
:language: yaml
|
: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.
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
- name: Playbook for role testing
|
- name: Playbook for role testing
|
||||||
hosts: localhost
|
hosts: localhost
|
||||||
remote_user: root
|
remote_user: root
|
||||||
roles:
|
roles:
|
||||||
- role: openstack-ansible-ironic
|
- role: openstack-ansible-os_ironic
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@ description-file =
|
||||||
README.rst
|
README.rst
|
||||||
author = OpenStack
|
author = OpenStack
|
||||||
author-email = openstack-dev@lists.openstack.org
|
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 =
|
classifier =
|
||||||
Intended Audience :: Developers
|
Intended Audience :: Developers
|
||||||
Intended Audience :: System Administrators
|
Intended Audience :: System Administrators
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue