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

Mm feature/fix broken doc generation #510

Conversation

mikemorency
Copy link
Collaborator

@mikemorency mikemorency commented Aug 6, 2024

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
  • Docs Pull Request
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.

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.

@mikemorency mikemorency force-pushed the mm-feature/fix-broken-doc-generation branch from 6100c85 to 8d30bf3 Compare August 7, 2024 15:12
@mikemorency mikemorency marked this pull request as ready for review August 7, 2024 15:14
@mikemorency
Copy link
Collaborator Author

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

Copy link
Contributor

Copy link
Contributor

Copy link
Collaborator

@mariolenz mariolenz left a 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?

Copy link
Contributor

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/2684a66a344c4d5fae0fbbd65959346b

✔️ ansible-test-cloud-integration-vmware-rest SUCCESS in 14m 19s
✔️ build-ansible-collection SUCCESS in 7m 45s
✔️ ansible-galaxy-importer SUCCESS in 4m 28s

Copy link
Contributor

Pull request merge failed: Resource not accessible by integration, You may need to manually rebase your PR and retry.

Copy link
Contributor

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/8fb88d91dbf04d719be7cf5838d8af87

✔️ ansible-test-cloud-integration-vmware-rest SUCCESS in 14m 56s
✔️ build-ansible-collection SUCCESS in 7m 44s
✔️ ansible-galaxy-importer SUCCESS in 3m 57s

Copy link
Contributor

Pull request merge failed: Resource not accessible by integration, You may need to manually rebase your PR and retry.

@mikemorency mikemorency merged commit e13cee0 into ansible-collections:main Aug 9, 2024
13 of 16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants