From 14671d51faac25f6b27436da299579f97ccc3b24 Mon Sep 17 00:00:00 2001
From: Robert Kaussow <mail@geeklabor.de>
Date: Tue, 8 Oct 2019 13:03:45 +0200
Subject: [PATCH] add example

---
 example/README.md                   | 139 ++++++++++++++++++++++++++++
 example/demo-role/defaults/main.yml |  30 ++++++
 example/demo-role/meta/main.yml     |  15 +++
 example/demo-role/tasks/main.yml    |   1 +
 4 files changed, 185 insertions(+)
 create mode 100644 example/README.md
 create mode 100644 example/demo-role/defaults/main.yml
 create mode 100644 example/demo-role/meta/main.yml
 create mode 100644 example/demo-role/tasks/main.yml

diff --git a/example/README.md b/example/README.md
new file mode 100644
index 0000000..2338594
--- /dev/null
+++ b/example/README.md
@@ -0,0 +1,139 @@
+# demo-role
+
+Role to demonstrate ansible-doctor
+
+## Default Variables
+
+### demo_role_unset
+
+#### Default value
+
+```YAML
+demo_role_unset:
+```
+
+#### Example usage
+
+```YAML
+demo_role_unset: some value
+```
+
+
+---
+
+### demo_role_empty
+
+#### Default value
+
+```YAML
+demo_role_empty: ''
+```
+
+---
+
+### demo_role_single
+
+#### Default value
+
+```YAML
+demo_role_single: b
+```
+
+---
+
+### demo_role_empty_dict
+
+#### Default value
+
+```YAML
+demo_role_empty_dict: {}
+```
+
+#### Example usage
+
+```YAML
+demo_role_empty_dict:
+  key1:
+    sub: some value
+  key2:
+    sublist:
+      - subval1
+      - subval2
+```
+
+
+---
+
+### demo_role_dict
+
+#### Default value
+
+```YAML
+demo_role_dict:
+  key1:
+    sub: some value
+```
+
+#### Example usage
+
+```YAML
+demo_role_dict:
+  key1:
+    sub: some value
+  key2:
+    sublist:
+      - subval1
+      - subval2
+```
+
+
+---
+
+### demo_role_other_tags
+
+The role requires epel repository and pip to work.
+You can use dockerengine_packages_extra to install these dependencys.
+
+#### Default value
+
+```YAML
+demo_role_other_tags: []
+```
+
+---
+
+### dockerengine_packages_extra
+
+#### Example usage
+
+```YAML
+dockerengine_packages_extra:
+  - package1
+  - package2
+```
+
+
+---
+
+### demo_role_undefined_var
+
+#### Default value
+
+```YAML
+demo_role_undefined_var: _undefined_
+```
+
+---
+
+## Dependencies
+
+None.
+
+## License
+
+MIT
+
+## Author
+
+Robert Kaussow <mail@example.com>
+
diff --git a/example/demo-role/defaults/main.yml b/example/demo-role/defaults/main.yml
new file mode 100644
index 0000000..5e72134
--- /dev/null
+++ b/example/demo-role/defaults/main.yml
@@ -0,0 +1,30 @@
+---
+demo_role_unset:
+# @var demo_role_unset:example: "some value"
+demo_role_empty: ""
+demo_role_single: 'b'
+# @var demo_role_empty_dict:example: {"key1": {"sub": "some value"}, "key2": {"sublist": ["subval1", "subval2"]}}
+demo_role_empty_dict: {}
+
+# @var demo_role_dict:example: >
+# demo_role_dict:
+#   key1:
+#     sub: some value
+#   key2:
+#     sublist:
+#       - subval1
+#       - subval2
+# @end
+demo_role_dict:
+  key1:
+    sub: some value
+
+# @var demo_role_other_tags:description: >
+# The role requires epel repository and pip to work.
+# You can use dockerengine_packages_extra to install these dependencys.
+# @end
+
+# @var dockerengine_packages_extra:example: ["package1", "package2"]
+demo_role_other_tags: []
+
+# @var demo_role_undefined_var: _undefined_
diff --git a/example/demo-role/meta/main.yml b/example/demo-role/meta/main.yml
new file mode 100644
index 0000000..40c1204
--- /dev/null
+++ b/example/demo-role/meta/main.yml
@@ -0,0 +1,15 @@
+---
+# @meta name: demo-role
+galaxy_info:
+  description: Role to demonstrate ansible-doctor
+  author: Robert Kaussow <mail@example.com>
+  license: MIT
+  min_ansible_version: 2.4
+  platforms:
+    - name: EL
+      versions:
+        - 7
+  galaxy_tags:
+    - demo
+    - documentation
+dependencies: []
diff --git a/example/demo-role/tasks/main.yml b/example/demo-role/tasks/main.yml
new file mode 100644
index 0000000..ed97d53
--- /dev/null
+++ b/example/demo-role/tasks/main.yml
@@ -0,0 +1 @@
+---