Readme for language plugins with specific info for SDK projects and features #5786
Labels
lifecycle/frozen
Indicates that an issue or PR should not be auto-closed due to staleness.
lifecycle/rotten
Denotes an issue or PR that has aged beyond stale and will be auto-closed.
needs discussion
priority/important-longterm
Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Milestone
Feature Request
Describe the problem you need a feature to resolve.
For Golang we scaffold a Readme file, see: kubernetes-sigs/kubebuilder#2610
I think it would be nice if we have the same for the other languages.
Additionally, wdyt about we have a helper plugin that adds on top the steps specific for SDK and how to test the bundle with the operator-sdk run bundle.
Describe the solution you'd like.
a) Ensure that we are OK with the default README scaffold via Kubebuilder ( see if we would like not to improve or change it first )
b) Then use this README as a base to create a template for all language plugins
c) Create a new helper plugin in SDK as we have manifest/v2 (https://github.com/operator-framework/operator-sdk/tree/master/internal/plugins/manifests/v2) which does changes on top of the Makefile so that we could encourage and skill up authors and users of these projects use operator-sdk run bundle as specific and nice helpers provided by SDK.
The text was updated successfully, but these errors were encountered: