From 2dc2c56b522cf239f9af24d8bd155a82e1921748 Mon Sep 17 00:00:00 2001 From: chadmf Date: Mon, 6 Dec 2021 16:52:56 -0600 Subject: [PATCH] fixed jina to use mostly markdown and added linters --- .github/linters/.markdown-lint.yml | 6 + .github/linters/ansible-lint.yml | 52 ++++ .github/linters/markdown-lint.yml | 35 +++ old-demo-repository/README.md | 287 ++++-------------- .../roles/generate_readme/templates/readme.j2 | 129 +++----- .../vars/main/developer/developer_report.yml | 4 +- 6 files changed, 184 insertions(+), 329 deletions(-) create mode 100644 .github/linters/.markdown-lint.yml create mode 100644 .github/linters/ansible-lint.yml create mode 100644 .github/linters/markdown-lint.yml diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml new file mode 100644 index 0000000..a0bc47d --- /dev/null +++ b/.github/linters/.markdown-lint.yml @@ -0,0 +1,6 @@ +{ + "default": true, + "MD003": false, + "MD013": false, + "MD033": false +} \ No newline at end of file diff --git a/.github/linters/ansible-lint.yml b/.github/linters/ansible-lint.yml new file mode 100644 index 0000000..1339519 --- /dev/null +++ b/.github/linters/ansible-lint.yml @@ -0,0 +1,52 @@ +--- +########################## +########################## +## Ansible Linter rules ## +########################## +########################## + +############################# +# Exclude paths from linter # +############################# +#exclude_paths: + +######################## +# Make output parsable # +######################## +parseable: true + +####################### +# Set output to quiet # +####################### +quiet: true + +##################### +# Path to rules dir # +##################### +#rulesdir: + +################ +# Tags to skip # +################ +skip_list: + - 'empty-string-compare' # Allow compare to empty string + - '204' # Allow string length greater than 160 chars + - 'no-changed-when' # False positives for running command shells + - 'command-instead-of-module' # Allow git commands for push, add, etc... + - 'command-instead-of-shell' # Allow use of shell when you want + - 'no-handler' # Allow step to run like handler + +################## +# Tags to follow # +################## +#tags: + +############# +# Use rules # +############# +use_default_rules: true + +################# +# Set verbosity # +################# +verbosity: 1 diff --git a/.github/linters/markdown-lint.yml b/.github/linters/markdown-lint.yml new file mode 100644 index 0000000..89963f4 --- /dev/null +++ b/.github/linters/markdown-lint.yml @@ -0,0 +1,35 @@ +--- +########################### +########################### +## Markdown Linter rules ## +########################### +########################### + +# Linter rules doc: +# - https://github.com/DavidAnson/markdownlint +# +# Note: +# To comment out a single error: +# +# any violations you want +# +# + +############### +# Rules by id # +############### +MD004: false # Unordered list style +MD007: + indent: 2 # Unordered list indentation +MD013: + line_length: 400 # Line length 80 is far to short +MD026: + punctuation: ".,;:!。，；:" # List of not allowed +MD029: false # Ordered list item prefix +MD033: false # Allow inline HTML +MD036: false # Emphasis used instead of a heading + +################# +# Rules by tags # +################# +blank_lines: false # Error on blank lines diff --git a/old-demo-repository/README.md b/old-demo-repository/README.md index cc1ff7e..1eb2c66 100644 --- a/old-demo-repository/README.md +++ b/old-demo-repository/README.md @@ -2,267 +2,90 @@ This repo currently under construction and working on a minimal viable demo for testing purposes -# Table of contents +## Table of contents - * [How to use](#how-to-use) - * [1. Provide login information and choose demo](#1-provide-login-information-and-choose-demo) - * [2. Run Ansible Playbook](#2-run-ansible-playbook) - * [Demo Repository](#demo-repository) - * [Infrastructure Demos](#infrastructure-demos) - * [Network Demos](#network-demos) - * [Security Demos](#security-demos) - * [Developer Demos](#developer-demos) - * [Contribute](#contribute) - * [Notes](#notes) +- [How to use](#how-to-use) + - [1. Provide login information and choose demo](#1-provide-login-information-and-choose-demo) + - [2. Run Ansible Playbook](#2-run-ansible-playbook) +- [Demo Repository](#demo-repository) + - [Infrastructure Demos](#infrastructure-demos) + - [Network Demos](#network-demos) + - [Security Demos](#security-demos) + - [Developer Demos](#developer-demos) +- [Contribute](#contribute) +- [Notes](#notes) -# How to use +## How to use ## 1. Provide login information and choose demo - - Modify the `choose_demo.yml` file that is included in this repo with the username, password and IP address (or DNS name) of your Ansible Tower - - Choose the demo name you want from the table below (or choose `all`) +- Modify the `choose_demo.yml` file that is included in this repo with the username, password and IP address (or DNS name) of your Ansible Tower +- Choose the demo name you want from the table below (or choose `all`) ## 2. Run Ansible Playbook -``` +```shell ansible-playbook playbooks/install_demo.yml -e @choose_demo.yml ``` -# Demo Repository +## Demo Repository -This repository currently holds 21 demos. +This repository currently holds 23 demos. ## Infrastructure Demos - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Demo NameAuthorinstall_demo.yml valueDescriptionVideo WalkthroughWorkshop Types
INFRASTRUCTURE / Azure create a MySQL ServerDavid Rojas
demo: azure_mysql_server
Provision MySQL server on Azure with Ansible Tower Survey and Environmental variablesNot available
  • windows
  • demo
INFRASTRUCTURE / Azure Provision VMDavid Rojas
demo: azure_provision_vm
Provision RHEL VM on Azure with Ansible Tower Survey and Environmental variablesNot available
  • windows
  • demo
INFRASTRUCTURE / Chocolatey App InstallDavid Rojas
demo: chocolatey_app_install
Install various application packages using Chocolatey from a surveyNot available
  • windows
  • demo
INFRASTRUCTURE / Chocolatey ConfigDavid Rojas
demo: chocolatey_config
Configure Chocolatey parameters that require not just enabling but adding valuesNot available
  • windows
  • demo
INFRASTRUCTURE / Chocolatey Features ConfigDavid Rojas
demo: chocolatey_features
Enable or disable various Chocolatey featuresNot available
  • windows
  • demo
INFRASTRUCTURE / Deploy ApplicationSean Cavanaugh
demo: deploy_application
install yum applications on Linux with a surveyVideo Link
  • f5
  • rhel
  • rhel_90
  • demo
INFRASTRUCTURE / Fact ScanWill Tome
demo: fact_scan
scan facts for Linux and Windows systemsNot available
  • f5
  • rhel
  • windows
  • rhel_90
  • demo
INFRASTRUCTURE / Gather Debug InfoWill Tome
demo: debug_info
provide info for memory and CPU usage for specified systemsNot available
  • f5
  • rhel
  • rhel_90
  • demo
INFRASTRUCTURE / Grant SudoWill Tome
demo: grant_sudo
grant sudo privledges for specified time via surveyNot available
  • f5
  • rhel
  • rhel_90
  • demo
INFRASTRUCTURE / PatchingWill Tome
demo: patching
patching for Linux serversNot available
  • f5
  • rhel
  • rhel_90
  • demo
INFRASTRUCTURE / Red Hat InsightsSean Cavanaugh
demo: insights
install and configure Red Hat InsightsNot available
  • f5
  • rhel
  • rhel_90
  • demo
INFRASTRUCTURE / Security PatchingWill Tome
demo: security_patching
upgrade all yum packages for security related except kernelNot available
  • f5
  • rhel
  • rhel_90
  • demo
INFRASTRUCTURE / Turn off IBM Community GridSean Cavanaugh
demo: turn_off_community_grid
this role turns off IBM Community Grid boinc-clientNot available
  • f5
  • rhel
  • rhel_90
  • demo
INFRASTRUCTURE / Windows regedit legal noticeDavid Rojas
demo: windows_regedit_legal_notice
using regedit modify the legal noticeNot available
  • windows
  • demo
SERVER / Windows IIS ServerColin McNaughton
demo: windows_iis
install webserver on Windows Server with a surveyNot available
  • windows
  • demo
+ +| Demo Name | Author | install_demo.yml value | Description | Video Walkthrough | Workshop Types | +| --------- | ------ | ---------------------- | ----------- | ----------------- | -------------- | +| [INFRASTRUCTURE / AWS Provision VM](https://github.com/ansible/product-demos/blob/master/docs/infrastructure/azure_provision_vm.md") | David Rojas | `demo: aws_provision_vm` | Provision RHEL VM on AWS with Ansible Tower Survey and Environmental variables | Not available |
  • windows
  • demo
    • | +| [INFRASTRUCTURE / Azure create a MySQL Server](https://github.com/ansible/product-demos/blob/master/docs/infrastructure/azure_mysql_server.md") | David Rojas | `demo: azure_mysql_server` | Provision MySQL server on Azure with Ansible Tower Survey and Environmental variables | Not available |
  • windows
  • demo
    • | +| [INFRASTRUCTURE / Azure Provision VM](https://github.com/ansible/product-demos/blob/master/docs/infrastructure/azure_provision_vm.md") | David Rojas | `demo: azure_provision_vm` | Provision RHEL VM on Azure with Ansible Tower Survey and Environmental variables | Not available |
  • windows
  • demo
    • | +| [INFRASTRUCTURE / Chocolatey App Install](https://github.com/ansible/product-demos/blob/master/docs/infrastructure/chocolatey_app_install.md") | David Rojas | `demo: chocolatey_app_install` | Install various application packages using Chocolatey from a survey | Not available |
  • windows
  • demo
    • | +| [INFRASTRUCTURE / Chocolatey Config](https://github.com/ansible/product-demos/blob/master/docs/infrastructure/chocolatey_config.md") | David Rojas | `demo: chocolatey_config` | Configure Chocolatey parameters that require not just enabling but adding values | Not available |
  • windows
  • demo
    • | +| [INFRASTRUCTURE / Chocolatey Features Config](https://github.com/ansible/product-demos/blob/master/docs/infrastructure/chocolatey_features.md") | David Rojas | `demo: chocolatey_features` | Enable or disable various Chocolatey features | Not available |
  • windows
  • demo
    • | +| [INFRASTRUCTURE / Deploy Application](https://github.com/ansible/product-demos/blob/master/docs/infrastructure/deploy_application.md") | Sean Cavanaugh | `demo: deploy_application` | install yum applications on Linux with a survey | [Video Link](https://www.youtube.com/watch?v=pU8ZgSBuEJw&list=PLdu06OJoEf2bp-PNtxPP_2n7Avkax8TED) |
  • f5
  • rhel
  • rhel_90
  • demo
    • | +| INFRASTRUCTURE / Fact Scan | Will Tome | `demo: fact_scan` | scan facts for Linux and Windows systems | Not available |
  • f5
  • rhel
  • windows
  • rhel_90
  • demo
    • | +| INFRASTRUCTURE / Gather Debug Info | Will Tome | `demo: debug_info` | provide info for memory and CPU usage for specified systems | Not available |
  • f5
  • rhel
  • rhel_90
  • demo
    • | +| INFRASTRUCTURE / Grant Sudo | Will Tome | `demo: grant_sudo` | grant sudo privledges for specified time via survey | Not available |
  • f5
  • rhel
  • rhel_90
  • demo
    • | +| INFRASTRUCTURE / Patching | Will Tome | `demo: patching` | patching for Linux servers | Not available |
  • f5
  • rhel
  • rhel_90
  • demo
    • | +| INFRASTRUCTURE / Red Hat Insights | Sean Cavanaugh | `demo: insights` | install and configure Red Hat Insights | Not available |
  • f5
  • rhel
  • rhel_90
  • demo
    • | +| INFRASTRUCTURE / Security Patching | Will Tome | `demo: security_patching` | upgrade all yum packages for security related except kernel | Not available |
  • f5
  • rhel
  • rhel_90
  • demo
    • | +| INFRASTRUCTURE / Turn off IBM Community Grid | Sean Cavanaugh | `demo: turn_off_community_grid` | this role turns off IBM Community Grid boinc-client | Not available |
  • f5
  • rhel
  • rhel_90
  • demo
    • | +| [INFRASTRUCTURE / Windows regedit legal notice](https://github.com/ansible/product-demos/blob/master/docs/infrastructure/windows_regedit_legal_notice.md") | David Rojas | `demo: windows_regedit_legal_notice` | using regedit modify the legal notice | Not available |
  • windows
  • demo
    • | +| SERVER / Windows IIS Server | Colin McNaughton | `demo: windows_iis` | install webserver on Windows Server with a survey | Not available |
  • windows
  • demo
    • | ## Network Demos - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Demo NameAuthorinstall_demo.yml valueDescriptionVideo WalkthroughWorkshop Types
    Cisco IOS logging config audit/remediationColin McCarthy
    demo: configlet_logging
    		Cisco IOS logging config audit/remediationNot available
    • network
    • demo
    Cisco IOS ntp config audit/remediationColin McCarthy
    demo: configlet_ntp
    		Cisco IOS ntp config audit/remediationNot available
    • network
    • demo
    NETWORK / WORKFLOW - F5 BIG-IPSean Cavanaugh
    demo: f5_bigip_workflow
    		Workflow for F5 BIG-IP to setup a VIP (Virtual IP) load balancer between two RHEL webserversNot available
    • f5
    • demo
    +| Demo Name | Author | install_demo.yml value | Description | Video Walkthrough | Workshop Types | +| --------- | ------ | ---------------------- | ----------- | ----------------- | -------------- | +| Cisco IOS logging config audit/remediation | Colin McCarthy | `demo: configlet_logging` | Cisco IOS logging config audit/remediation | Not available |
  • network
  • demo
    • | +| Cisco IOS ntp config audit/remediation | Colin McCarthy | `demo: configlet_ntp` | Cisco IOS ntp config audit/remediation | Not available |
  • network
  • demo
    • | +| Cisco IOS VTY ACL config audit/remediation | George James | `demo: configlet_vtyacl` | Cisco IOS VTY ACL config audit/remediation | Not available |
  • network
  • demo
    • | +| NETWORK / WORKFLOW - F5 BIG-IP | Sean Cavanaugh | `demo: f5_bigip_workflow` | Workflow for F5 BIG-IP to setup a VIP (Virtual IP) load balancer between two RHEL webservers | Not available |
  • f5
  • demo
    • | ## Security Demos - - - - - - - - - - - - - - - - - - - - - - - - - -
    Demo NameAuthorinstall_demo.yml valueDescriptionVideo WalkthroughWorkshop Types
    SECURITY / Create Openscap ReportSean Cavanaugh
    demo: openscap
    		Create HTML report using SCAP Security Guide (SSG)Not available
    • f5
    • rhel
    • rhel_90
    • demo
    SECURITY / HardeningWill Tome
    demo: hardening
    		hardening for Linux serversNot available
    • f5
    • rhel
    • rhel_90
    • demo
    +| Demo Name | Author | install_demo.yml value | Description | Video Walkthrough | Workshop Types | +| --------- | ------ | ---------------------- | ----------- | ----------------- | -------------- | +| SECURITY / Create Openscap Report | Sean Cavanaugh | `demo: openscap` | Create HTML report using SCAP Security Guide (SSG) | Not available |
  • f5
  • rhel
  • rhel_90
  • demo
    • | +| SECURITY / Hardening | Will Tome | `demo: hardening` | hardening for Linux servers | Not available |
  • f5
  • rhel
  • rhel_90
  • demo
    • | ## Developer Demos - - - - - - - - - - - - - - - - - -
    Demo NameAuthorinstall_demo.yml valueDescriptionVideo WalkthroughWorkshop Types
    DEVELOPER / Create Developer ReportSean Cavanaugh
    demo: developer_report
    		'Create HTML report using Ansible facts' -Not available
    • f5
    • rhel
    • rhel_90
    • demo
    +| Demo Name | Author | install_demo.yml value | Description | Video Walkthrough | Workshop Types | +| --------- | ------ | ---------------------- | ----------- | ----------------- | -------------- | +| DEVELOPER / Create Developer Report | Sean Cavanaugh | `demo: developer_report` |Create HTML report using [Ansible facts](https://docs.ansible.com/ansible/latest/user_guide/playbooks_variables.html#variables-discovered-from-systems-facts) +| Not available |
  • f5
  • rhel
  • rhel_90
  • demo
    • | +## Contribute -# Contribute +Please refer to the [contribute.md](docs/contribute.md) documentation included in this collection. -please refer to the [contribute.md](docs/contribute.md) documentation included in this collection. +## Notes -# Notes - -This README.md was auto-generated by Ansible user **colin** on **2020-12-09** with Ansible version **2.9.13.post0** +This README.md was auto-generated by Ansible user **chadmf*- on **2021-12-06*- with Ansible version **2.9.27** To generate a README.md, execute the following command -``` +```shell ansible-playbook playbooks/generate_readme.yml ``` diff --git a/old-demo-repository/roles/generate_readme/templates/readme.j2 b/old-demo-repository/roles/generate_readme/templates/readme.j2 index fbde842..bc275a0 100644 --- a/old-demo-repository/roles/generate_readme/templates/readme.j2 +++ b/old-demo-repository/roles/generate_readme/templates/readme.j2 @@ -2,135 +2,74 @@ This repo currently under construction and working on a minimal viable demo for testing purposes -# Table of contents +## Table of contents - * [How to use](#how-to-use) - * [1. Provide login information and choose demo](#1-provide-login-information-and-choose-demo) - * [2. Run Ansible Playbook](#2-run-ansible-playbook) - * [Demo Repository](#demo-repository) - * [Infrastructure Demos](#infrastructure-demos) - * [Network Demos](#network-demos) - * [Security Demos](#security-demos) - * [Developer Demos](#developer-demos) - * [Contribute](#contribute) - * [Notes](#notes) +- [How to use](#how-to-use) + - [1. Provide login information and choose demo](#1-provide-login-information-and-choose-demo) + - [2. Run Ansible Playbook](#2-run-ansible-playbook) +- [Demo Repository](#demo-repository) + - [Infrastructure Demos](#infrastructure-demos) + - [Network Demos](#network-demos) + - [Security Demos](#security-demos) + - [Developer Demos](#developer-demos) +- [Contribute](#contribute) +- [Notes](#notes) -# How to use +## How to use ## 1. Provide login information and choose demo - - Modify the `choose_demo.yml` file that is included in this repo with the username, password and IP address (or DNS name) of your Ansible Tower - - Choose the demo name you want from the table below (or choose `all`) +- Modify the `choose_demo.yml` file that is included in this repo with the username, password and IP address (or DNS name) of your Ansible Tower +- Choose the demo name you want from the table below (or choose `all`) ## 2. Run Ansible Playbook -``` +```shell ansible-playbook playbooks/install_demo.yml -e @choose_demo.yml ``` -# Demo Repository +## Demo Repository This repository currently holds {{job_template_definitions.items()|sort(attribute='1.name')|count}} demos. ## Infrastructure Demos - - - - - - - - - -{% for key, value in job_template_definitions.items()|selectattr('1.category', 'match', 'infrastructure$')|sort(attribute='1.name') %} - - - - - - - - + +| Demo Name | Author | install_demo.yml value | Description | Video Walkthrough | Workshop Types | +| --------- | ------ | ---------------------- | ----------- | ----------------- | -------------- | +{% for key, value in job_template_definitions.items()|selectattr('1.category', 'match', 'infrastructure$')|sort(attribute='1.name') %}| {% if value.readme is defined%}[{{value.name}}]({{ value.readme}}"){% else %}{{value.name}}{% endif %} | {{value.author}} | `demo: {{key}}` | {{value.description}} | {% if value.video is defined%}[Video Link]({{ value.video}}){% else %}Not available {% endif %} | {% for workshop in value.workshop_type %}
  • {{workshop}}
    • {% endfor %} | {% endfor %} -
    Demo NameAuthorinstall_demo.yml valueDescriptionVideo WalkthroughWorkshop Types
    {% if value.readme is defined%}{{value.name}}{% else %}{{value.name}}{% endif %}{{value.author}}
    demo: {{key}}
    		{{value.description}}{% if value.video is defined%}Video Link{% else %}Not available {% endif %}
      {% for workshop in value.workshop_type %}
    • {{workshop}}
      • {% endfor %}
    ## Network Demos - - - - - - - - - -{% for key, value in job_template_definitions.items()|selectattr('1.category', 'match', 'network$')|sort(attribute='1.name') %} - - - - - - - +| Demo Name | Author | install_demo.yml value | Description | Video Walkthrough | Workshop Types | +| --------- | ------ | ---------------------- | ----------- | ----------------- | -------------- | +{% for key, value in job_template_definitions.items()|selectattr('1.category', 'match', 'network$')|sort(attribute='1.name') %}| {% if value.readme is defined%}[{{value.name}}]({{ value.readme}}"){% else %}{{value.name}}{% endif %} | {{value.author}} | `demo: {{key}}` | {{value.description}} | {% if value.video is defined%}[Video Link]({{ value.video}}){% else %}Not available {% endif %} | {% for workshop in value.workshop_type %}
  • {{workshop}}
    • {% endfor %} | {% endfor %} -
    Demo NameAuthorinstall_demo.yml valueDescriptionVideo WalkthroughWorkshop Types
    {{ value.name }}{{ value.author }}
    demo: {{key }}
    		{{ value.description }}{% if value.video is defined %}Video Link{% else %}Not available {% endif %}
      {% for workshop in value.workshop_type %}
    • {{ workshop }}
      • {% endfor %}
    ## Security Demos - - - - - - - - - -{% for key, value in job_template_definitions.items()|selectattr('1.category', 'match', 'security$')|sort(attribute='1.name') %} - - - - - - - +| Demo Name | Author | install_demo.yml value | Description | Video Walkthrough | Workshop Types | +| --------- | ------ | ---------------------- | ----------- | ----------------- | -------------- | +{% for key, value in job_template_definitions.items()|selectattr('1.category', 'match', 'security$')|sort(attribute='1.name') %}| {% if value.readme is defined%}[{{value.name}}]({{ value.readme}}"){% else %}{{value.name}}{% endif %} | {{value.author}} | `demo: {{key}}` | {{value.description}} | {% if value.video is defined%}[Video Link]({{ value.video}}){% else %}Not available {% endif %} | {% for workshop in value.workshop_type %}
  • {{workshop}}
    • {% endfor %} | {% endfor %} -
    Demo NameAuthorinstall_demo.yml valueDescriptionVideo WalkthroughWorkshop Types
    {{ value.name }}{{ value.author }}
    demo: {{ key }}
    		{{ value.description }}{% if value.video is defined %}Video Link{% else %}Not available {% endif %}
      {% for workshop in value.workshop_type %}
    • {{ workshop }}
      • {% endfor %}
    ## Developer Demos - - - - - - - - - -{% for key, value in job_template_definitions.items()|selectattr('1.category', 'match', 'developer$')|sort(attribute='1.name') %} - - - - - - - +| Demo Name | Author | install_demo.yml value | Description | Video Walkthrough | Workshop Types | +| --------- | ------ | ---------------------- | ----------- | ----------------- | -------------- | +{% for key, value in job_template_definitions.items()|selectattr('1.category', 'match', 'developer$')|sort(attribute='1.name') %}| {% if value.readme is defined%}[{{value.name}}]({{ value.readme}}"){% else %}{{value.name}}{% endif %} | {{value.author}} | `demo: {{key}}` |{{value.description}}| {% if value.video is defined%}[Video Link]({{ value.video}}){% else %}Not available {% endif %} | {% for workshop in value.workshop_type %}
  • {{workshop}}
    • {% endfor %} | {% endfor %} -
    Demo NameAuthorinstall_demo.yml valueDescriptionVideo WalkthroughWorkshop Types
    {{ value.name }}{{ value.author }}
    demo: {{ key }}
    		{{ value.description }}{% if value.video is defined %}Video Link{% else %}Not available {% endif %}
      {% for workshop in value.workshop_type %}
    • {{ workshop }}
      • {% endfor %}
    +## Contribute -# Contribute +Please refer to the [contribute.md](docs/contribute.md) documentation included in this collection. -please refer to the [contribute.md](docs/contribute.md) documentation included in this collection. +## Notes -# Notes - -This README.md was auto-generated by Ansible user **{{ ansible_user_id }}** on **{{ ansible_date_time.date }}** with Ansible version **{{ ansible_version.full }}** +This README.md was auto-generated by Ansible user **{{ ansible_user_id }}*- on **{{ ansible_date_time.date }}*- with Ansible version **{{ ansible_version.full }}** To generate a README.md, execute the following command -``` +```shell ansible-playbook playbooks/generate_readme.yml ``` diff --git a/old-demo-repository/roles/install_demo/vars/main/developer/developer_report.yml b/old-demo-repository/roles/install_demo/vars/main/developer/developer_report.yml index 62711f5..a2ae712 100644 --- a/old-demo-repository/roles/install_demo/vars/main/developer/developer_report.yml +++ b/old-demo-repository/roles/install_demo/vars/main/developer/developer_report.yml @@ -4,8 +4,8 @@ developer_report: category: developer name: "DEVELOPER / Create Developer Report" description: > - 'Create HTML report using - Ansible facts' + Create HTML report using + [Ansible facts](https://docs.ansible.com/ansible/latest/user_guide/playbooks_variables.html#variables-discovered-from-systems-facts) job_type: "run" inventory: "Workshop Inventory" playbook: "playbooks/developer/developer_report.yml"