[check_for_dangling_images] Remove README.md file

This patch removes the README.md file and adds the documentation
directly in the sphinx role documentation index. All variables have been
commented with a proper description to be included automatically in the
sphinx build.

Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
Change-Id: I32ede7b8070ef6dcc22df982b0a3417753fb4a77
This commit is contained in:
Gael Chamoulaud (Strider) 2021-06-08 13:07:05 +02:00
parent 0a37793cdc
commit e871121e6f
No known key found for this signature in database
GPG Key ID: 4119D0305C651D66
3 changed files with 40 additions and 38 deletions

View File

@ -2,7 +2,44 @@
check_for_dangling_images
=========================
.. literalinclude:: ../../../roles/check_for_dangling_images/README.md
--------------
About the role
--------------
Ansible role to check for dangling images
Requirements
============
This role will be executed pre Update.
Dependencies
============
No Dependencies
Example Playbook
================
.. code-block:: yaml
- hosts: servers
roles:
- { role: check_for_dangling_images, check_for_dangling_images_debug: true }
License
=======
Apache
Author Information
==================
**Red Hat TripleO DFG:Upgrades**
----------------
Full Description
----------------
.. ansibleautoplugin::
:role: roles/check_for_dangling_images

View File

@ -1,37 +0,0 @@
Check-for-dangling-images
=========================
Add Ansible role to check for dangling images
Requirements
------------
This role will be executed pre Update.
Role Variables
--------------
* `check_for_dangling_images_debug`: <'false'> -- debugging mode.
Dependencies
------------
No Dependencies
Example Playbook
----------------
- hosts: servers
roles:
- { role: check_for_dangling_images, check_for_dangling_images_debug: true }
License
-------
Apache
Author Information
------------------
Red Hat TripleO DFG:Upgrades

View File

@ -18,4 +18,6 @@
# All variables intended for modification should place placed in this file.
# All variables within this role should have a prefix of "check_for_dangling_images"
# Debugging mode
check_for_dangling_images_debug: false