-
Notifications
You must be signed in to change notification settings - Fork 65
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
Mm feature/fix broken doc generation #510
Mm feature/fix broken doc generation #510
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
6100c85
to
8d30bf3
Compare
The failing checks are due to bad workflow configs already on main (meaning i cant change the "cancelled" results). When this PR is merged, future checks should all pass on main |
Build succeeded. ✔️ ansible-test-cloud-integration-vmware-rest SUCCESS in 16m 03s |
Build succeeded. ✔️ ansible-test-cloud-integration-vmware-rest SUCCESS in 11m 04s |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The failing checks are due to bad workflow configs already on main (meaning i cant change the "cancelled" results). When this PR is merged, future checks should all pass on main
Well, let's merge the CI and test this?
edit:
Maybe by closing and re-opening #508?
Build succeeded (gate pipeline). ✔️ ansible-test-cloud-integration-vmware-rest SUCCESS in 14m 19s |
Pull request merge failed: Resource not accessible by integration, You may need to manually rebase your PR and retry. |
Build succeeded (gate pipeline). ✔️ ansible-test-cloud-integration-vmware-rest SUCCESS in 14m 56s |
Pull request merge failed: Resource not accessible by integration, You may need to manually rebase your PR and retry. |
SUMMARY
This change fixes issues in the module documentation related to bad formatting or broken references. These issues are blocking PRs, and were introduced when we added more workflows to generate docs on each PR
For the RST docs, the issues are simply formatting/escaping problems. Those are easily fixed.
For the module docs with broken references, those references have been removed. A long term fix will need to be figured out since these issues will come back when modules are re-generated.
ISSUE TYPE
COMPONENT NAME
content_locallibrary
content_subscribedlibrary
vcenter_storage_policies_info
vcenter_vm
vcenter_vm_hardware_disk
vcenter_vm_power
vcenter_vm_storage_policy
ADDITIONAL INFORMATION
I opened an issue to document this problem: #509
Ive removed the bad documentation as a quick fix for the current modules but when we generate the next version (which should be vcenter 8.0.2) we will need to either fix the openapi spec before generation or go back through the new modules and fix the docs there.