Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bugfix/typos in docs #104

Merged
merged 4 commits into from
Oct 8, 2024
Merged

Conversation

mikemorency
Copy link
Collaborator

This fixes a ton of typos and grammatical errors throughout the collection. I used the document generated by QE to guide the changes.

I also tried to update the provision_vm documentation to be a bit more readable since that was noted as being particularly difficult by QE. I think its because there are so many options that were copied from the community module, leading to weird syntax.

I also updated our role dependency docs to match other validated content collections. They use that section to identify pre-req steps, system requirements, and other miscellaneous dependencies rather than python or collection deps.

@anna-savina
Copy link
Collaborator

@mikemorency Why didn't you specify dependencies for roles?

Dependencies
N/A

@anna-savina
Copy link
Collaborator

cluster_settings role:

https://github.com/redhat-cop/cloud.vmware_ops/pull/104/files#diff-4b3a77ab2c4520eb346a208302798319f1e9b04629125d05638f9aaf2459029dR86

Suggestion:

  - 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`

https://github.com/redhat-cop/cloud.vmware_ops/pull/104/files#diff-4b3a77ab2c4520eb346a208302798319f1e9b04629125d05638f9aaf2459029dR30

Suggestion:

  - str or int, The port used to authenticate to the vSphere vCenter that contains the cluster to configure.

@anna-savina
Copy link
Collaborator

content_library role:

https://github.com/redhat-cop/cloud.vmware_ops/pull/104/files#diff-b79baabe2c4381009ee3fdb5a3357da78cdffd0f562090e6c1508664e5debb44R49

- **content_library_ssl_thumbprint**:

@anna-savina
Copy link
Collaborator

deploy_ovf:

https://github.com/redhat-cop/cloud.vmware_ops/pull/104/files#diff-e8b805f5c57b32c56b5deab96655d02081262a8294697a55e1830ed7d15ad09bR151

      deploy_ovf_library: my-content-library

@anna-savina
Copy link
Collaborator

anna-savina commented Oct 6, 2024

export_vm_as_ovf role:

https://github.com/redhat-cop/cloud.vmware_ops/pull/104/files#diff-2ac5bb4d54196e20a8f6f9f556f51c999b00a38e05b1a044ab77e93b346e0a91R76

- name: Export VM To Localhost

https://github.com/redhat-cop/cloud.vmware_ops/pull/104/files#diff-2ac5bb4d54196e20a8f6f9f556f51c999b00a38e05b1a044ab77e93b346e0a91R30

  - str or int, The port used to authenticate to the vSphere vCenter that contains the cluster to configure.

@mikemorency
Copy link
Collaborator Author

@anna-savina
Other similar collections, like aws_ops, azure_ops, or gcp_ops, do not list python or ansible dependencies in their role docs. They only list those in the collection level docs/galaxy file. Instead, they list system requirements like OS packages or pre-req steps that must be done.

Most of our roles have no requirements like that. I did list some for the vcenter and esxi provisioning roles.

Heres some examples for reference:
https://console.redhat.com/ansible/automation-hub/repo/validated/cloud/gcp_ops/content/role/clone_on_prem_vm/
https://console.redhat.com/ansible/automation-hub/repo/validated/cloud/azure_ops/content/role/azure_load_balancer_with_public_ip/
https://console.redhat.com/ansible/automation-hub/repo/validated/cloud/aws_ops/content/role/awsconfig_apigateway_with_lambda_integration/

Copy link
Collaborator

@anna-savina anna-savina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mikemorency mikemorency merged commit 7e8fbfd into redhat-cop:main Oct 8, 2024
18 of 19 checks passed
@mikemorency mikemorency deleted the bugfix/typos-in-docs branch October 8, 2024 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants