When new roles are created following the contributing process, documentation will now be automatically generated using the role itself as content. The automatic documentation process has been added to the role-addition.yml playbook making it easy for developers to get started. Change-Id: Idba128e441a1a4fdff30ff1b9105f7ca8d199345 Signed-off-by: Kevin Carter <kecarter@redhat.com>changes/75/665475/2
parent
196bee0821
commit
53eddac2de
@ -0,0 +1,9 @@
|
||||
Documented roles in TripleO-Ansible
|
||||
===================================
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
|
||||
roles/*
|
@ -0,0 +1,23 @@
|
||||
================================
|
||||
TripleO-Ansible Role - test_deps
|
||||
================================
|
||||
|
||||
This role provides for the following services:
|
||||
|
||||
* test_deps
|
||||
|
||||
|
||||
Default variables
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. literalinclude:: ../../../tripleo_ansible/roles/test_deps/defaults/main.yml
|
||||
:language: yaml
|
||||
:start-after: under the License.
|
||||
|
||||
|
||||
Example playbook
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
.. literalinclude:: ../../../tripleo_ansible/roles/test_deps/molecule/default/playbook.yml
|
||||
:language: yaml
|
||||
:start-after: under the License.
|
@ -0,0 +1,23 @@
|
||||
============================
|
||||
TripleO-Ansible Role - tuned
|
||||
============================
|
||||
|
||||
This role provides for the following services:
|
||||
|
||||
* tuned
|
||||
|
||||
|
||||
Default variables
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. literalinclude:: ../../../tripleo_ansible/roles/tuned/defaults/main.yml
|
||||
:language: yaml
|
||||
:start-after: under the License.
|
||||
|
||||
|
||||
Example playbook
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
.. literalinclude:: ../../../tripleo_ansible/roles/tuned/molecule/default/playbook.yml
|
||||
:language: yaml
|
||||
:start-after: under the License.
|
Loading…
Reference in new issue