-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Open
Labels
kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.Indicates that an issue or PR should not be auto-closed due to staleness.
Milestone
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: OLM Integration Bundle Quickstart is not quick #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.
Metadata
Metadata
Assignees
Labels
kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.Indicates that an issue or PR should not be auto-closed due to staleness.
