operator-framework / operator-framework/operator-sdk
OLM Integration is not clear for end-users
Open
@estroz is already working on this.
Since Feb 22, 2021.
kind/documentation
lifecycle/frozen
- Dominant language
- Go
- Stars
- 7.7k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.