Mm feature/fix nested lists in docs (#109)

* standardizing readme formats

* add changelog

* readme typos and grammar suggestions

* suggestions

changelogs/fragments/109-standardize-role-readmes.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - Standardize role README formatting

docs/authentication.md

@@ -1,6 +1,6 @@
 # Authentication Variables
 
-Each role in this collection has its own set of authentication and proxy variables. It is not convnient to set those variables for every role, so there are options to set the variables for all roles in the collection at once.
+Each role in this collection has its own set of authentication and proxy variables. It is not convenient to set those variables for every role, so there are options to set the variables for all roles in the collection at once.
 
 Here is the order of precedence from greatest to least (the first listed variables override all other variables):
 

roles/content_library/README.md

@@ -10,77 +10,84 @@ N/A
 
 ### Auth
 
-- **content_library_username**:
-  - The vSphere vCenter username.
-  - If this variable is not set, the collection level variable `vmware_ops_username` will be used. If that variable is not set, the environment variable `VMWARE_USER` will be used. At least one of these variables must be set to use this role.
-  - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
-
-- **content_library_password**:
-  - The vSphere vCenter password.
-  - If this variable is not set, the collection level variable `vmware_ops_password` will be used. If that variable is not set, the environment variable `VMWARE_PASSWORD` will be used. At least one of these variables must be set to use this role.
-  - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
-
-- **content_library_hostname**:
-  - The hostname or IP address of the vSphere vCenter.
-  - If this variable is not set, the collection level variable `vmware_ops_hostname` will be used. If that variable is not set, the environment variable `VMWARE_HOST` will be used. At least one of these variables must be set to use this role.
-  - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
-
-- **content_library_validate_certs**
-  - Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
-  - If this variable is not set, the collection level variable `vmware_ops_validate_certs` will be used. If that variable is not set, the environment variable `VMWARE_VALIDATE_CERTS` will be used.
-  - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
-
-- **content_library_port**:
-  - str or int, The port used to authenticate to the vSphere vCenter that contains the cluster to configure.
-  - If this variable is not set, the collection level variable `vmware_ops_port` will be used. If that variable is not set, the environment variable `VMWARE_PORT` will be used.
-  - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
+- **content_library_hostname** (str, required)
+    - The hostname or IP address of the vSphere vCenter.
+    - If this variable is not set, the collection level variable `vmware_ops_hostname` will be used. If that variable is not set, the environment variable `VMWARE_HOST` will be used. At least one of these variables must be set to use this role.
+    - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
+
+- **content_library_username** (str, required)
+    - The vSphere vCenter username.
+    - If this variable is not set, the collection level variable `vmware_ops_username` will be used. If that variable is not set, the environment variable `VMWARE_USER` will be used. At least one of these variables must be set to use this role.
+    - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
+
+- **content_library_password** (str, required)
+    - The vSphere vCenter password.
+    - If this variable is not set, the collection level variable `vmware_ops_password` will be used. If that variable is not set, the environment variable `VMWARE_PASSWORD` will be used. At least one of these variables must be set to use this role.
+    - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
+
+- **content_library_validate_certs** (bool)
+    - Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
+    - If this variable is not set, the collection level variable `vmware_ops_validate_certs` will be used. If that variable is not set, the environment variable `VMWARE_VALIDATE_CERTS` will be used.
+    - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
+
+- **content_library_port** (int or str)
+    - The port used to authenticate to the vSphere vCenter that contains the cluster to configure.
+    - If this variable is not set, the collection level variable `vmware_ops_port` will be used. If that variable is not set, the environment variable `VMWARE_PORT` will be used.
+    - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
+
+### Proxy
+
+- **content_library_proxy_host** (str)
+    - The hostname of a proxy host that should be used for all HTTPs communication by the role.
+    - The format is a hostname or an IP.
+    - If this variable is not set, the collection level variable `vmware_ops_proxy_host` will be used. If that variable is not set, the environment variable `VMWARE_PROXY_HOST` will be used.
+    - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
+
+- **content_library_proxy_port** (str or int)
+    - The port of a proxy host that should be used for all HTTPs communication by the role
+    - If this variable is not set, the collection level variable `vmware_ops_proxy_host` will be used. If that variable is not set, the environment variable `VMWARE_PROXY_PORT` will be used.
+    - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
 
 ### Library
-- **content_library_cluster_name**:
-  - The name of the cluster in vSphere vCenter to configure.
 
-- **content_library_datacenter_name**:
-  - The name of the datacenter in vSphere vCenter which contains the cluster to configure.
+- **content_library_cluster_name** (str)
+    - The name of the cluster in vSphere vCenter to configure.
 
-- **content_library_datastore_name**:
-  - str, The name of the local datastore that should be used as storage for the content library. Required if state is `present`
+- **content_library_datacenter_name** (str)
+    - The name of the datacenter in vSphere vCenter which contains the cluster to configure.
 
-- **content_library_description**:
-  - str, A description to attach to the content library
+- **content_library_datastore_name** (str)
+    - The name of the local datastore that should be used as storage for the content library.
+    - Required if state is `present`
 
-- **content_library_name**:
-  - str, Required. The name of the content library to manage
+- **content_library_description** (str)
+    - A description to attach to the content library
 
-- **content_library_state**:
-  - str, `present` or `absent`. Controls if the library should be created or deleted. Default is `present`
+- **content_library_name** (str, required)
+    - The name of the content library to manage
 
-- **content_library_type**:
-  - str, `local` or `subscribed`. Controls if the library will be hosted locally or should subscribe to a remote library
+- **content_library_state** (str)
+    - Controls if the library should be created or deleted
+    - Default is `present`
+    - Choices: [`present`, `absent`]
 
-#### Subscribed Library Settings
-- **content_library_ssl_thumbprint**:
-  - str, The SSL thumbprint of the content library you want to which you want to subscribe.
+- **content_library_type** (str)
+    - Controls if the library will be hosted locally or should subscribe to a remote library
+    - Choices: [`local`, `subscribed`]
 
-- **content_library_subscription_url**:
-  - str, The URL of the library to which you want to subscribe
+#### Subscribed Library Settings
 
-- **content_library_update_on_demand**:
-  - bool, If true, content in the library will be updated when it is requested. If false, the content is updated regularly
+- **content_library_ssl_thumbprint** (str)
+    - The SSL thumbprint of the content library you want to which you want to subscribe.
 
-### Other
-- **content_library_proxy_host**:
-  - str, The hostname of a proxy host that should be used for all HTTPs communication by the role. Optional
-  - The format is a hostname or an IP.
-  - If this variable is not set, the collection level variable `vmware_ops_proxy_host` will be used. If that variable is not set, the environment variable `VMWARE_PROXY_HOST` will be used.
-  - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
+- **content_library_subscription_url** (str)
+    - The URL of the library to which you want to subscribe
 
-- **content_library_proxy_port**:
-  - str, The port of a proxy host that should be used for all HTTPs communication by the role. Optional
-  - If this variable is not set, the collection level variable `vmware_ops_proxy_host` will be used. If that variable is not set, the environment variable `VMWARE_PROXY_PORT` will be used.
-  - See the [authentication documentation](https://github.com/redhat-cop/cloud.vmware_ops/blob/main/docs/authentication.md) for examples.
+- **content_library_update_on_demand** (bool)
+    - If true, content in the library will be updated when it is requested. If false, the content is updated regularly
 
+## Examples
 
-## Example Playbook
 ```yaml
 ---
 - name: Manage VMWare Content Library
@@ -98,6 +105,7 @@ N/A
         content_library_name: my-content-library
         content_library_type: local
 ```
+
 ## License
 
 GNU General Public License v3.0 or later