You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We have some unwritten expectations/requirements for example bundles that should be explained in our CONTRIBUTING.md file:
name, version and registry are required. Do not use reference.
The bundle README.md should provide enough information that someone can copy/paste their way to victory and installing the example bundle. So include any configuration/setup such as required credentials, parameters, or infrastructure (like a cluster). It's okay to link to a doc that explains how to do that stuff, you don't need to repeat it. Also include a "Try it out" section that gives them the install command with all required parameters/flags included.
If the bundle provisions any resources, include a "Cleanup" section that walks them through uninstalling the bundle cleanly so that they aren't billed for any lingering resources.
The text was updated successfully, but these errors were encountered:
We have some unwritten expectations/requirements for example bundles that should be explained in our CONTRIBUTING.md file:
The text was updated successfully, but these errors were encountered: