Add survey to README (#31)

Author: alessfg

CHANGELOG.md

@@ -6,6 +6,11 @@ BREAKING CHANGES:
 
 *   The default port of the status module is now 8080 and matches the CI molecule test which already used it. Set ```nginx_config_status_port```to another desired value.
 
+ENHANCEMENTS:
+
+*   Add survey to README.
+*   Improve README structure and use tables where relevant.
+
 BUG FIXES:
 
 *   Prevent TravisCI from trying to build (and failing) NGINX Plus images on external PRs.

README.md

@@ -1,40 +1,42 @@
-Ansible NGINX Configuration Role
-================================
+[![Ansible Galaxy](https://img.shields.io/badge/galaxy-nginxinc.nginx__config-5bbdbf.svg)](https://galaxy.ansible.com/nginxinc/nginx_config)
+[![Build Status](https://travis-ci.org/nginxinc/ansible-role-nginx-config.svg?branch=main)](https://travis-ci.org/nginxinc/ansible-role-nginx-config)
+[![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+# 👾 *Help make the NGINX config Ansible role better by participating in our [survey](https://forms.office.com/Pages/ResponsePage.aspx?id=L_093Ttq0UCb4L-DJ9gcUKLQ7uTJaE1PitM_37KR881UM0NCWkY5UlE5MUYyWU1aTUcxV0NRUllJSC4u)!* 👾
+
+# Ansible NGINX Configuration Role
 
 This role configures NGINX Open Source and NGINX Plus on your target host.
 
 **Note:** This role is still in active development. There may be unidentified issues and the role variables may change as development continues.
 
-Requirements
-------------
-
-**Ansible**
+## Requirements
 
-This role was developed and tested with [maintained](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#release-status) versions of Ansible. Backwards compatibility is not guaranteed.
+### Ansible
 
-Instructions on how to install Ansible can be found in the [Ansible website](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html).
+*   This role is developed and tested with [maintained](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#release-status) versions of Ansible. Backwards compatibility is not guaranteed.
+*   Instructions on how to install Ansible can be found in the [Ansible website](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html).
 
-**Molecule**
+### Molecule
 
-Molecule is used to test the various functionailities of the role. Instructions on how to install Molecule can be found in the [Molecule website](https://molecule.readthedocs.io/en/latest/installation.html).
+*   Molecule `3.x` is used to test the various functionalities of the role.
+*   Instructions on how to install Molecule can be found in the [Molecule website](https://molecule.readthedocs.io/en/latest/installation.html).
 
-Installation
-------------
+## Installation
 
-**Ansible Galaxy**
+### Ansible Galaxy
 
 Use `ansible-galaxy install nginxinc.nginx_config` to install the latest stable release of the role on your system.
 
-**Git**
+### Git
 
 Use `git clone https://github.com/nginxinc/ansible-role-nginx-config.git` to pull the latest edge commit of the role from GitHub.
 
-Platforms
----------
+## Platforms
 
-The NGINX Ansible role supports all platforms supported by [NGINX Open Source](https://nginx.org/en/linux_packages.html#mainline) and [NGINX Plus](https://www.nginx.com/products/technical-specs/):
+The NGINX config Ansible role supports all platforms supported by [NGINX Open Source](https://nginx.org/en/linux_packages.html#mainline) and [NGINX Plus](https://www.nginx.com/products/technical-specs/):
 
-**NGINX Open Source**
+### NGINX Open Source
 
 ```yaml
 Alpine:
@@ -63,14 +65,13 @@ Ubuntu:
   - focal
 ```
 
-**NGINX Plus**
+### NGINX Plus
 
 ```yaml
 Alpine:
   - 3.9
   - 3.10
   - 3.11
-  - 3.12
 Amazon Linux:
   - 2018.03
 Amazon Linux 2:
@@ -102,46 +103,47 @@ Ubuntu:
   - focal
 ```
 
-Role Variables
---------------
+## Role Variables
 
-This role has multiple variables. The descriptions and defaults for all these variables can be found in the **`defaults/main/`** directory in the following files:
+This role has multiple variables. The descriptions and defaults for all these variables can be found in the **[`defaults/main/`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/)** folder in the following files:
 
--   **[defaults/main/main.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/main.yml):** NGINX simple config variables
--   **[defaults/main/selinux.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/selinux.yml):** Set up SELinux to allow the necessary connections to your NGINX setup
--   **[defaults/main/template.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/template.yml):** NGINX config template variables
--   **[defaults/main/upload.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/upload.yml):** NGINX config/HTML/SSL upload variables
+|Name|Description|
+|----|-----------|
+|**[`main.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/main.yml)**|NGINX simple config variables|
+|**[`selinux.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/selinux.yml)**|Set up SELinux to allow the necessary connections to your NGINX setup|
+|**[`template.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/template.yml)**|NGINX config template variables|
+|**[`upload.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/upload.yml)**|NGINX config/HTML/SSL upload variables|
 
-Example Playbooks
------------------
+## Example Playbooks
 
-Working functional playbook examples can be found in the **`molecule/common/`** directory in the following files:
+Working functional playbook examples can be found in the **[`molecule/`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/)** folder in the following files:
 
--   **[molecule/cleanup_module/converge.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/cleanup_module/converge.yml):** Cleanup an NGINX config and configure NGINX supported modules
--   **[molecule/default/converge.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/default/converge.yml):** Use the NGINX config templating variables to create an NGINX config
--   **[molecule/plus/converge.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/plus/converge.yml):** Use the NGINX config templating variables to create an NGINX Plus config
--   **[molecule/stable_push/converge.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/stable_push/converge.yml):** Install NGINX using the stable branch and push a preexisting config from your system to your NGINX instance
+|Name|Description|
+|----|-----------|
+|**[`cleanup_module/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/cleanup_module/converge.yml)**|Cleanup an NGINX config and configure NGINX supported modules|
+|**[`default/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/default/converge.yml)**|Use the NGINX config templating variables to create an NGINX config|
+|**[`plus/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/plus/converge.yml)**|Use the NGINX config templating variables to create an NGINX Plus config|
+|**[`stable_push/converge.yml`](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/stable_push/converge.yml)**|Install NGINX using the stable branch and push a preexisting config from your system to your NGINX instance|
 
 Do note that if you install this repository via Ansible Galaxy, you will have to replace the role variable in the sample playbooks from `ansible-role-nginx-config` to `nginxinc.nginx_config`.
 
-Other NGINX Roles
------------------
+## Other NGINX Ansible Collections and Roles
+
+You can find the Ansible NGINX Core collection of roles to install and configure NGINX Open Source, NGINX Plus, and NGINX App Protect [here](https://github.com/nginxinc/ansible-collection-nginx).
 
-You can find an Ansible role to install NGINX [here](https://github.com/nginxinc/ansible-role-nginx)
+You can find the Ansible NGINX role to install NGINX [here](https://github.com/nginxinc/ansible-role-nginx).
 
-You can find an Ansible role to help you install and configure NGINX App Protect [here](https://github.com/nginxinc/ansible-role-nginx-app-protect)
+You can find the Ansible NGINX App Protect role to install and configure NGINX App Protect [here](https://github.com/nginxinc/ansible-role-nginx-app-protect).
 
-You can find an Ansible collection of roles to help you install and configure NGINX Controller [here](https://github.com/nginxinc/ansible-collection-nginx_controller)
+You can find the Ansible NGINX Controller collection of roles to install and configure NGINX Controller [here](https://github.com/nginxinc/ansible-collection-nginx_controller).
 
-You can find an Ansible role to install NGINX Unit [here](https://github.com/nginxinc/ansible-role-nginx-unit)
+You can find the Ansible NGINX Unit role to install NGINX Unit [here](https://github.com/nginxinc/ansible-role-nginx-unit).
 
-License
--------
+## License
 
 [Apache License, Version 2.0](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/LICENSE)
 
-Author Information
-------------------
+## Author Information
 
 [Alessandro Fael Garcia](https://github.com/alessfg)