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.

Sign up for GitHub

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

Jump to bottom

Autogenerate docs in CRD catalog upon modification of CRDs #1715

Closed
sgayangi opened this issue Sep 5, 2023 · 1 comment · Fixed by #1726
Closed

Autogenerate docs in CRD catalog upon modification of CRDs #1715

sgayangi opened this issue Sep 5, 2023 · 1 comment · Fixed by #1726
Assignees
@sgayangi
Milestone
1.0.0-rc2

Comments

@sgayangi
Copy link
Contributor

sgayangi commented Sep 5, 2023

Description:
Instead of manually updating the docs in https://apk.docs.wso2.com/en/latest/catalogs/kubernetes-crds/ whenever any CRD changes are done, autogenerate the catalog documentation in response to such changes.

Refer https://github.com/kubernetes-sigs/gateway-api/blob/90a3c7234ecec6927747911ad1b99b9375098837/hack/make-docs.sh
@sgayangi sgayangi self-assigned this Sep 5, 2023
@sgayangi sgayangi changed the title Autogenerate docs in CR catalog upon modification of CRs Autogenerate docs in CRD catalog upon modification of CRDs Sep 5, 2023
@sgayangi
Copy link
Contributor Author

sgayangi commented Sep 6, 2023

Fixed in #1726

@sgayangi sgayangi closed this as completed Sep 6, 2023
@CrowleyRajapakse CrowleyRajapakse added this to the 1.0.0-rc2 milestone Sep 7, 2023
@sgayangi sgayangi mentioned this issue May 7, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sgayangi sgayangi

Labels
None yet
Projects
APK Development
Status: ✅ Done/Done
Milestone
1.0.0-rc2
Development

Successfully merging a pull request may close this issue.

Autogenerate CRD docs sgayangi/apk
2 participants
@CrowleyRajapakse @sgayangi