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

Feature/centralize doc fragments #86

Conversation

mikemorency
Copy link
Collaborator

SUMMARY

This is preparing the pymomi module utils to be made public. The main change here is cleaning up the doc fragments. Eventually, we can combine the rest and pyvmomi doc fragments. The only significant differences between them is

  1. pyvmomi has two versions of the doc frags, one with cluster/datacenter and one without
  2. rest has the protocol parameter

So far in this repo, the cluster/datacenter documentation is re-written in every module so its not needed in the doc frag. I think thats a good trend to carry on going forward, and it has the added benefit of making the writer consider if cluster and datacenter are required, optional, or unused in their module.

The protocol parameter is unused by pyvmomi, but I dont think theres any harm in including it. Iit makes our lives easier since we dont need to maintain two copies of the doc frag thats 95% redundant. And theres no harm in the user setting it for pyvmomi since that SDK automatically determines the protocol anyway

This change does not update the REST utils doc fragments, that should come later

ISSUE TYPE
  • Feature Pull Request
COMPONENT NAME

module_utils/_vmware doc fragments

@mikemorency
Copy link
Collaborator Author

FYI this will need to be combined with #87 before it can be merged, but I am going to leave them separate for now so its easier to review

@mikemorency mikemorency requested a review from mariolenz December 4, 2024 20:09
Copy link
Collaborator Author

@mikemorency mikemorency Dec 4, 2024

Choose a reason for hiding this comment

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

this is a frustratingly complex diff from github.

  1. added the note about the requests library
  2. added the proxy_protocol option with an alias to protocol
  3. removed the VCENTER_DOCUMENTATION block

@mariolenz
Copy link
Collaborator

#87 (comment)

@mikemorency
Copy link
Collaborator Author

closing in favor of #89

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