Merge pull request #104 from mikemorency/bugfix/typos-in-docs

Bugfix/typos in docs

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+---
+repos:
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell

CHANGELOG.rst

@@ -61,9 +61,9 @@ Minor Changes
 - esxi_maintenance_mode - add role metadata
 - esxi_maintenance_mode test - adding the integartion test for esxi_maintenance_mode role
 - export_vm_as_ovf - add role metadata
-- export_vm_as_ovf - added role, playbook, tests to export an exisiting VM from VCenter or ESXi as an OVF
+- export_vm_as_ovf - added role, playbook, tests to export an existing VM from VCenter or ESXi as an OVF
 - export_vm_as_ovf - adding check on ovf file in integration tests for export_vm_as_ovf role
-- general change to the testing structure which duplicate runme.sh for each target instead of recreating it manaully
+- general change to the testing structure which duplicate runme.sh for each target instead of recreating it manually
 - info - add role metadata
 - info_test - adding a CI for validated content repo to run on a real vcenter env, and include this test within the pr
 - manage_folder - Added new role, tests, and playbook to create or delete a folder in VCenter
@@ -94,9 +94,9 @@ Minor Changes
 - add_esxi_host_to_vcenter - Added new playbook to add an ESXi host to a vCenter
 - cluster_settings - Added new playbook to modify cluster settings
 - cluster_settings - Added new role for managing different cluster settings including DRM, DRS, vCLS, HA, and vSAN. Added integration tests for role
-- disable_high_availability - Added playbook to disable high availbility in  a vcenter cluster
+- disable_high_availability - Added playbook to disable high availability in  a vcenter cluster
 - disable_maintenance_mode - Added new playbook to disable maintenance mode on an ESXi host
-- enable_high_availability - Added playbook to enable and configure high availbility in a vcenter cluster
+- enable_high_availability - Added playbook to enable and configure high availability in a vcenter cluster
 - enable_maintenance_mode - Added new playbook to enable maintenance mode on an ESXi host
 - esxi_maintenance_mode - Added new role for setting an ESXi host's maintenance mode status. Added integration tests for role
 - info - Fix creation of temporary files

changelogs/changelog.yaml

@@ -35,11 +35,11 @@ releases:
       - cluster_settings - Added new playbook to modify cluster settings
       - cluster_settings - Added new role for managing different cluster settings
         including DRM, DRS, vCLS, HA, and vSAN. Added integration tests for role
-      - disable_high_availability - Added playbook to disable high availbility in  a
+      - disable_high_availability - Added playbook to disable high availability in  a
         vcenter cluster
       - disable_maintenance_mode - Added new playbook to disable maintenance mode
         on an ESXi host
-      - enable_high_availability - Added playbook to enable and configure high availbility
+      - enable_high_availability - Added playbook to enable and configure high availability
         in a vcenter cluster
       - enable_maintenance_mode - Added new playbook to enable maintenance mode on
         an ESXi host
@@ -108,12 +108,12 @@ releases:
       - esxi_maintenance_mode test - adding the integartion test for esxi_maintenance_mode
         role
       - export_vm_as_ovf - add role metadata
-      - export_vm_as_ovf - added role, playbook, tests to export an exisiting VM from
+      - export_vm_as_ovf - added role, playbook, tests to export an existing VM from
         VCenter or ESXi as an OVF
       - export_vm_as_ovf - adding check on ovf file in integration tests for export_vm_as_ovf
         role
       - general change to the testing structure which duplicate runme.sh for each
-        target instead of recreating it manaully
+        target instead of recreating it manually
       - info - add role metadata
       - info_test - adding a CI for validated content repo to run on a real vcenter
         env, and include this test within the pr

changelogs/fragments/104-fix-typos-and-grammar-in-docs.yml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - fixed typos and grammatical errors in documentation, task names, and changelogs

playbooks/esxi_management/add_esxi_host_to_vcenter.yml

@@ -1,5 +1,5 @@
 ---
-- name: Playbook To Add An ESXI Host To VCenter
+- name: Playbook To Add An ESXi Host To VCenter
   hosts: all
   gather_facts: false
 

playbooks/esxi_management/disable_maintenance_mode.yml

@@ -1,5 +1,5 @@
 ---
-- name: Playbook To Remove An ESXI Host From Maintenance Mode
+- name: Playbook To Remove An ESXi Host From Maintenance Mode
   hosts: all
   gather_facts: false
 

playbooks/esxi_management/enable_maintenance_mode.yml

@@ -1,5 +1,5 @@
 ---
-- name: Playbook To Put An ESXI Host In Maintenance Mode
+- name: Playbook To Put An ESXi Host In Maintenance Mode
   hosts: all
   gather_facts: false
 

playbooks/esxi_management/reconnect_esxi_host_in_vcenter.yml

@@ -1,5 +1,5 @@
 ---
-- name: Playbook To Reconnect An ESXI Host In VCenter
+- name: Playbook To Reconnect An ESXi Host In VCenter
   hosts: all
   gather_facts: false
 

playbooks/esxi_management/remove_esxi_host_from_vcenter.yml

@@ -1,5 +1,5 @@
 ---
-- name: Playbook To Remove An ESXI Host From VCenter
+- name: Playbook To Remove An ESXi Host From VCenter
   hosts: all
   gather_facts: false
 

playbooks/info.yml

@@ -1,4 +1,4 @@
-- name: Gather infomation about VMware
+- name: Gather information about VMware
   hosts: all
   gather_facts: false
 

roles/cluster_settings/README.md

@@ -2,9 +2,9 @@
 
 A role to define cluster settings in vCenter.
 
-## Requirements
+## Dependencies
 
-pyvmomi
+N/A
 
 ## Role Variables
 ### Auth
@@ -27,7 +27,7 @@ pyvmomi
   - The name of the datacenter in vSphere vCenter which contains the cluster to configure.
 
 - **cluster_settings_port**:
-  - str or int, The port to use to authenticate to the vSphere vCenter which contains the cluster to configure.
+  - str or int, The port used to authenticate to the vSphere vCenter that contains the cluster to configure.
 
 ### Cluster settings
 
@@ -83,7 +83,7 @@ pyvmomi
   - str, State of virtual machine health monitoring service. One of `vmAndAppMonitoring`, `vmMonitoringDisabled`, `vmMonitoringOnly`
 
 - **cluster_settings_ha_host_isolation_response**:
-  - str, Indicates whether or VMs should be powered off if a host determines that it is isolated from the rest of the compute resource. One of `none`, `powerOff`, `powerOn`
+  - str, Indicates whether VMs should be powered off if a host determines that it is isolated from the rest of the compute resource. One of `none`, `powerOff`, `powerOn`
 
 - **cluster_settings_ha_slot_based_admission_control**:
   - dict, Configure slot based admission control policy.
@@ -136,7 +136,7 @@ pyvmomi
   - Used only when `cluster_settings_ha_apd_response` is `restartConservative` or `restartAggressive`.
 
 - **cluster_settings_ha_pdl_response**:
-  - str, VM storage protection setting for storage failures categorized as Permenant Device Loss (PDL).
+  - str, VM storage protection setting for storage failures categorized as Permanent Device Loss (PDL).
   - Options are `disabled`, `warning`, `restartAggressive`
 
 
@@ -169,10 +169,6 @@ pyvmomi
   - str, The port of a proxy host that should be used for all HTTPs communication by the role. Optional
 
 
-## Dependencies
-
-- vmware.vmware_rest
-
 ## Example Playbook
 ```yaml
 ---
@@ -187,7 +183,7 @@ pyvmomi
 
 GNU General Public License v3.0 or later
 
-See [LICENCE](https://github.com/ansible-collections/cloud.aws_troubleshooting/blob/main/LICENSE) to see the full text.
+See [LICENSE](https://github.com/ansible-collections/cloud.aws_troubleshooting/blob/main/LICENSE) to see the full text.
 
 ## Author Information
 

roles/content_library/README.md

@@ -1,8 +1,8 @@
 # content_library
 
-A role to manage VMWare content libaries. You can create or delete both local and subscribed content libraries.
+A role to manage VMWare content libraries. You can create or delete both local and subscribed content libraries.
 
-## Requirements
+## Dependencies
 
 N/A
 
@@ -27,7 +27,7 @@ N/A
   - The name of the datacenter in vSphere vCenter which contains the cluster to configure.
 
 - **content_library_port**:
-  - str or int, The port to use to authenticate to the vSphere vCenter which contains the cluster to configure.
+  - str or int, The port used to authenticate to the vSphere vCenter that contains the cluster to configure.
 
 ### Library
 - **content_library_datastore_name**:
@@ -46,7 +46,7 @@ N/A
   - str, `local` or `subscribed`. Controls if the library will be hosted locally or should subscribe to a remote library
 
 #### Subscribed Library Settings
-- **content_library_ssl_thumbrpint**:
+- **content_library_ssl_thumbprint**:
   - str, The SSL thumbprint of the content library you want to which you want to subscribe.
 
 - **content_library_subscription_url**:
@@ -63,10 +63,6 @@ N/A
   - str, The port of a proxy host that should be used for all HTTPs communication by the role. Optional
 
 
-## Dependencies
-
-- community.vmware
-
 ## Example Playbook
 ```yaml
 ---
@@ -89,7 +85,7 @@ N/A
 
 GNU General Public License v3.0 or later
 
-See [LICENCE](https://github.com/ansible-collections/cloud.aws_troubleshooting/blob/main/LICENSE) to see the full text.
+See [LICENSE](https://github.com/ansible-collections/cloud.aws_troubleshooting/blob/main/LICENSE) to see the full text.
 
 ## Author Information
 

roles/deploy_ovf/README.md

@@ -2,31 +2,31 @@
 
 A role to deploy a VM from an OVF file. The OVF can be located on the `ansible_host` filesystem, at a URL, or located in a content library.
 
-## Requirements
+## Dependencies
 
 N/A
 
 ## Role Variables
 ### Auth
 - **deploy_ovf_username**:
-  - str, Required. The vSphere vCenter or ESXI host username.
+  - str, Required. The vSphere vCenter or ESXi host username.
 
 - **deploy_ovf_password**:
-  - str, Required. The vSphere vCenter or ESXI host password.
+  - str, Required. The vSphere vCenter or ESXi host password.
 
 - **deploy_ovf_hostname**:
-  - str, Required. The hostname or IP address of the vSphere vCenter or ESXI host.
+  - str, Required. The hostname or IP address of the vSphere vCenter or ESXi host.
 
 - **deploy_ovf_validate_certs**
   - bool, Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
 
 - **deploy_ovf_port**:
-  - str or int, The port to use to authenticate to the vSphere vCenter or ESXI host.
+  - str or int, The port used to authenticate to the vSphere vCenter or ESXi host.
 
 
 ### Placement
 - **deploy_ovf_cluster_name**:
-  - str, The name of the cluster in vSphere vCenter to configure. Required if your connecting to a vcenter cluster and `deploy_ovf_esxi_host` is not provided.
+  - str, The name of the cluster in vSphere vCenter to configure. Required if you are connecting to a vCenter cluster and `deploy_ovf_esxi_host` is not provided.
 
 - **deploy_ovf_datacenter_name**:
   - str, Required. The name of the datacenter in vSphere vCenter where the virtual machine should be deployed.
@@ -117,9 +117,6 @@ N/A
 - **deploy_ovf_proxy_port**:
   - str, The port of a proxy host that should be used for all HTTPs communication by the role. Optional
 
-## Dependencies
-
-- community.vmware
 
 ## Example Playbook
 ```yaml
@@ -151,7 +148,7 @@ N/A
       deploy_ovf_datacenter_name: DC1
       deploy_ovf_cluster_name: CL1
       deploy_ovf_vm_name: test-vm
-      deploy_ovf_libarary: my-content-library
+      deploy_ovf_library: my-content-library
       deploy_ovf_template: my-ovf-template
       deploy_ovf_datastore: datastore1
 
@@ -174,7 +171,7 @@ N/A
 
 GNU General Public License v3.0 or later
 
-See [LICENCE](https://github.com/ansible-collections/cloud.aws_troubleshooting/blob/main/LICENSE) to see the full text.
+See [LICENSE](https://github.com/ansible-collections/cloud.aws_troubleshooting/blob/main/LICENSE) to see the full text.
 
 ## Author Information
 

roles/esxi_maintenance_mode/README.md

@@ -1,28 +1,28 @@
 # esxi_maintenance_mode
 
-Either put an ESXI host in maintenance mode or take the host out of maintenance mode.
+Either put an ESXi host in maintenance mode or take the host out of maintenance mode.
 
-## Requirements
+## Dependencies
 
-pyvomi
+N/A
 
 ## Role Variables
 
 ### Auth
 - **esxi_maintenance_mode_hostname**:
-  - str, The hostname of the esxi or vcenter on which you want to deploy the application. Required.
+  - str, The hostname of the ESXi or vCenter on which you want to deploy the application. Required.
 
 - **esxi_maintenance_mode_username**:
-  - str, The username to use to authenticate to the esxi or vcenter on which you want to deploy the application. Required.
+  - str, The username to use to authenticate to the ESXi or vCenter on which you want to deploy the application. Required.
 
 - **esxi_maintenance_mode_password**:
-  - str, The password to use to authenticate to the esxi or vcenter on which you want to deploy the application. Required.
+  - str, The password to use to authenticate to the ESXi or vCenter on which you want to deploy the application. Required.
 
 - **esxi_maintenance_mode_port**:
-  - str or int, The port to use to authenticate to the esxi or vcenter on which you want to deploy the application. Required.
+  - str or int, The port to use to authenticate to the ESXi or vCenter on which you want to deploy the application. Required.
 
 - **esxi_maintenance_mode_validate_certs**:
-  - bool, If true then certificates will be validated when connecting to the esxi or vcenter for auth. Optional.
+  - bool, If true then certificates will be validated when connecting to the ESXi or vCenter for auth. Optional.
 
 ### Proxy Options
 
@@ -34,14 +34,14 @@ pyvomi
 
 ### Other Options
 - **esxi_maintenance_mode_enable**:
-  - bool, If true the ESXI host will be put into maintenance mode. If false, the host will be taken out of maintenance mode
+  - bool, If true the ESXi host will be put into maintenance mode. If false, the host will be taken out of maintenance mode
   - Default value is True
 
 - **esxi_maintenance_mode_esxi_hostname**:
-  - str, The hostname of the ESXI host that you want to manage. Required
+  - str, The hostname of the ESXi host that you want to manage. Required
 
 - **esxi_maintenance_mode_evacuate**:
-  - bool, If true, powered off VMs on the ESXI host will be evacuated.
+  - bool, If true, powered off VMs on the ESXi host will be evacuated.
 
 - **esxi_maintenance_mode_timeout**:
   - int, Set the length of time to wait for the host to move into the appropriate maintenance state before throwing an error.
@@ -50,9 +50,6 @@ pyvomi
   - str, Set the VSAN compliance mode for the host to enter.
   - One of `ensureObjectAccessibility`, `evacuateAllData`, `noAction`
 
-## Dependencies
-
-- NA
 
 ## Example Playbook
 ```yaml
@@ -88,7 +85,7 @@ License
 
 GNU General Public License v3.0 or later
 
-See [LICENCE](https://github.com/ansible-collections/cloud.aws_troubleshooting/blob/main/LICENSE) to see the full text.
+See [LICENSE](https://github.com/ansible-collections/cloud.aws_troubleshooting/blob/main/LICENSE) to see the full text.
 
 Author Information
 ------------------

roles/esxi_maintenance_mode/tasks/main.yml

@@ -10,7 +10,7 @@
     quiet: true
     fail_msg: Variable must be set when using this role.
 
-- name: Set ESXI Maintenance Mode
+- name: Set ESXi Maintenance Mode
   community.vmware.vmware_maintenancemode:
     hostname: "{{ esxi_maintenance_mode_hostname }}"
     username: "{{ esxi_maintenance_mode_username }}"