From e5be8fb969461cc02fadc1ea0e6aad02b679bac4 Mon Sep 17 00:00:00 2001
From: "Gael Chamoulaud (Strider)" <gchamoul@redhat.com>
Date: Thu, 24 Jun 2021 07:06:19 +0200
Subject: [PATCH] [no_op] Add role documentation in sphinx

This patch 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.

This patch also disables the facts gathering because this validation
doesn't need them.

Change-Id: I99a506d17a2e76c9513745db877e5ce0ba3aae6a
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
---
 doc/source/roles/role-no_op.rst         | 40 +++++++++++++++++++++++++
 validations_common/playbooks/no-op.yaml |  1 +
 2 files changed, 41 insertions(+)

diff --git a/doc/source/roles/role-no_op.rst b/doc/source/roles/role-no_op.rst
index bf328d1..f717478 100644
--- a/doc/source/roles/role-no_op.rst
+++ b/doc/source/roles/role-no_op.rst
@@ -2,5 +2,45 @@
 no_op
 =====
 
+--------------
+About The Role
+--------------
+
+A no-op Ansible role for testing that the validations framework runs.
+
+Requirements
+============
+
+No requirements.
+
+Dependencies
+============
+
+No dependencies.
+
+Example Playbook
+================
+
+.. code-block:: yaml
+
+   - hosts: localhost
+     gather_facts: false
+     roles:
+       - no_op
+
+License
+=======
+
+Apache
+
+Author Information
+==================
+
+**Red Hat TripleO DFG:DF Squad:VF**
+
+----------------
+Full Description
+----------------
+
 .. ansibleautoplugin::
    :role: validations_common/roles/no_op
diff --git a/validations_common/playbooks/no-op.yaml b/validations_common/playbooks/no-op.yaml
index d064c38..3a4a734 100644
--- a/validations_common/playbooks/no-op.yaml
+++ b/validations_common/playbooks/no-op.yaml
@@ -1,5 +1,6 @@
 ---
 - hosts: localhost
+  gather_facts: false
   vars:
     metadata:
       name: NO-OP validation