Readme for language plugins with specific info for SDK projects and features

[camilamacedo86]

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.

[varshaprasad96]

@camilamacedo86 For the step 3, do you mean to create a new plugin for scaffolding an olm bundle to support all OLM commands (like run, upgrade bundle etc). The plugin will basically replace the generate bundle command. If so, that is definitely a priority for Operator-SDK. And since that is an involved process, it would probably need a separate issue to track it down.

[camilamacedo86]

Hi @varshaprasad96,

@camilamacedo86 For the step 3, do you mean to create a new plugin for scaffolding an olm bundle to support all OLM commands (like run, upgrade bundle etc). The plugin will basically replace the generate bundle command. If so, that is definitely a priority for Operator-SDK. And since that is an involved process, it would probably need a separate issue to track it down.

No, This plugin is only to add content to the README file scaffold by default regards what is specific for SKD. Example: Add on the bottom of the readme how to test the solution with the operator-sdk run bundle.

It is only about the README file content.

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[openshift-bot]

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale