operator-framework
OLM Integration is not clear for end-users
Problem
OLM Integration is not clear for end-users. The menu is confusing and it is very hard to find where you would find the information that you are looking for such as to follow up it. The docs do not follow any logical sequence and are not encourage the users to use bundle instead pkgmanifest format. See: https://sdk.operatorframework.io/docs/olm-integration/
Suggestion
├── OLM Integration
├── QuickStart
├── For SKD projects
├── For Non-SKD projects
├── Bundle Format (recommended)
├── How to build
├── How to validate
├── How to test
├── How to upgrade
├── PkgManifest Format (legacy)
├── How to build
├── How to validate
├── How to test
├── CLI Overview
NOTES
- We have an issue raised specifically for we working on in the QuickStart: https://github.com/operator-framework/operator-sdk/issues/4527. It was applied to be easier we address all needs.
- The tutorials on how to build, how to validate and how to test would cover a detailed explanation over it for SDK and Non-SDK projects as well. E.g full description, example and steps for SDK project and then example and steps to perform the action with a Non-SDK one.
Since we've deprecated packagemanifests, I'd actually like to hide those docs (not remove them) and retitle bundle-related docs. The sidebar/titles should be more clear then.
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
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
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
/lifecycle frozen
@jmrodri @varshaprasad96 @rashmigottipati it was with @estroz but it is very unlike that he will be able to work on this one. Could we see if any other person can get this one? Also, what about we add it in a milestone?