carvel-dev / carvel-dev/kapp-controller
Kubernetes-style API reference
- Dominant language
- Go
- Stars
- 323
- Forks
- 127
- Avg merge
- 2d 16h
- Merged PRs (30d)
- 4
Description
**Describe the problem/challenge you have**
The API references right now are a big YAML document with comments. For issues like https://github.com/vmware-tanzu/carvel-kapp-controller/issues/415 it would be nice if we had a way to go into more detail with actual links, ala https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/
**Describe the solution you'd like**
Investigate what we can do to create better API docs. Big bonus if these are generated from our code rather than hand-written in the docs repo.
**Anything else you would like to add:**
- https://kubernetes.io/docs/reference/kubernetes-api
- https://cert-manager.io/docs/reference/api-docs/
- https://knative.dev/docs/reference/api/serving-api/
---
Vote on this request
This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.
👍 "I would like to see this addressed as soon as possible"
👎 "There are other more important things to focus on right now"
We are also happy to receive and review Pull Requests if you want to help working on this issue.
Contributor guide
Assessment
This issue has not been assessed yet.