akuity
Docs bug: https://doc.crds.dev/github.com/akuity/kargo is broken since 1.6.0
Checklist
- [x] I've searched the issue queue to verify this is not a duplicate bug report.
- [x] I've included steps to reproduce the bug.
- [x] I've pasted the output of
kargo version. - [x] I've pasted logs, if applicable.
Description
https://doc.crds.dev/github.com/akuity/kargo is linked into the doc to easllly access the CRDs structure. This is broken from 1.6.0 and only displays the top resources name.
My thinking is that any of the 1.6+ branch/tags does not contain any yaml version of the full CRD. The only crd.yaml file is a helm template.
CRDs were previously available, ex: https://github.com/akuity/kargo/tree/v1.5.3/charts/kargo/resources/crds
According to the code used by doc.crds.dev, they just clone the repo and parse any *.yaml file for a valid CRD...
Solve the bug
the full CRDs as yaml should be included in the repo.
Another way around would be to add them to another repo, and update the docs to point to https://doc.crds.dev/github.com/akuity/<kargo-repo-with-crds>
Screenshots
Expending any field will lead o a blank page:
Steps to Reproduce
- open https://doc.crds.dev/github.com/akuity/kargo in your browser
- click on a CRD
- expand any of the fields of the CRD
Version
does not apply
Logs
does not apply
My thinking is that any of the 1.6+ branch/tags does not contain any yaml version of the full CRD.
An interesting theory, but it isn't true. Right up to our latest release, the CRDs still exist in the same path you referenced:
https://github.com/akuity/kargo/tree/v1.7.2/charts/kargo/resources/crds
Visiting https://doc.crds.dev/github.com/akuity/kargo, I don't see any problems.
What am I missing?
It's broken for specific CRDs, namely, Warehouses (others appear to work fine). Still broken as of v1.8
Tinkered with this a bit and have concluded with certainty that there are JS errors when navigating Warehouse docs on doc.crds.dev. The problem would seem to be on their end.