From d3fc18bab1d789b20bee0f1b5da3f7f594048816 Mon Sep 17 00:00:00 2001
From: "Gael Chamoulaud (Strider)" <gchamoul@redhat.com>
Date: Wed, 23 Jun 2021 13:00:10 +0200
Subject: [PATCH] [check_cpu] 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.

Change-Id: Icc9581821b5ba9c2bef7c0608d989e7044017ae6
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
---
 doc/source/roles/role-check_cpu.rst           | 42 +++++++++++++++++++
 validations_common/roles/check_cpu/README.md  | 36 ----------------
 .../roles/check_cpu/defaults/main.yml         |  1 +
 3 files changed, 43 insertions(+), 36 deletions(-)
 delete mode 100644 validations_common/roles/check_cpu/README.md

diff --git a/doc/source/roles/role-check_cpu.rst b/doc/source/roles/role-check_cpu.rst
index c6f4cd4..2924be2 100644
--- a/doc/source/roles/role-check_cpu.rst
+++ b/doc/source/roles/role-check_cpu.rst
@@ -2,5 +2,47 @@
 check_cpu
 =========
 
+--------------
+About The Role
+--------------
+
+An Ansible role to check if the Host(s) fit(s) the CPU core requirements
+
+Requirements
+============
+
+No requirements.
+
+Dependencies
+============
+
+No dependencies.
+
+Example Playbook
+================
+
+.. code-block:: yaml
+
+   - hosts: localhost
+     gather_facts: false
+     vars:
+       minimal_cpu_count: 42
+     roles:
+       - check_cpu
+
+License
+=======
+
+Apache
+
+Author Information
+==================
+
+**Red Hat TripleO DFG:DF Squad:VF**
+
+----------------
+Full Description
+----------------
+
 .. ansibleautoplugin::
    :role: validations_common/roles/check_cpu
diff --git a/validations_common/roles/check_cpu/README.md b/validations_common/roles/check_cpu/README.md
deleted file mode 100644
index 3b7728a..0000000
--- a/validations_common/roles/check_cpu/README.md
+++ /dev/null
@@ -1,36 +0,0 @@
-Undercloud-cpu
-==============
-
-An Ansible role to check if the Undercloud fits the CPU core requirements
-
-Requirements
-------------
-
-This role could be used before or/and after the Undercloud installation.
-
-Role Variables
---------------
-
-- min_undercloud_cpu_count: <8> -- Minimal number of CPU core
-
-Dependencies
-------------
-
-No dependencies.
-
-Example Playbook
-----------------
-
-    - hosts: undercloud
-      roles:
-         - { role: undercloud-cpu, min_undercloud_cpu_count: 42 }
-
-License
--------
-
-Apache 2.0
-
-Author Information
-------------------
-
-Red Hat TripleO Validations Team
diff --git a/validations_common/roles/check_cpu/defaults/main.yml b/validations_common/roles/check_cpu/defaults/main.yml
index df8f7bd..470e611 100644
--- a/validations_common/roles/check_cpu/defaults/main.yml
+++ b/validations_common/roles/check_cpu/defaults/main.yml
@@ -1,2 +1,3 @@
 ---
+# Minimal number of CPU core
 minimal_cpu_count: 8