carvel-dev
Document recommended best practices for Package Authors
Describe the problem/challenge you have For a new package author, they can read the current kapp-controller to understand how to create a package and then distribute it in a package repository bundle. However, since they are new, they might benefit from a dedicated docs page that talks about the recommended best practices that they should follow.
Describe the solution you'd like Create a dedicated docs page for recommended best practices for Package Authors. Few of the things that can be a part of this doc:
- [ ] Recommended list of metadata for packages such as icon, description, categories, release notes, etc. Most of this metadata is not required by the APIs, however, it would be helpful to document the recommended ones that will help the consumers of the packages.
- [ ] The best practices for versioning the packages.
- [ ] The best practices to create package repository bundles and how to update them when new packages are available.
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.
