openshift / openshift/openshift-docs
[enterprise-4.11] Issue in file operators/understanding/olm-understanding-operatorhub.adoc
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 883
- Forks
- 2k
- Avg merge
- 21h 5m
- Merged PRs (30d)
- 737
Description
Which section(s) is the issue in?
Example OperatorHub custom resource
What needs fixing?
Listing "Example OperatorHub custom resource" makes no sense. If I already disabled "All default catalog sources" why would I also disable the "community operators" catalog source? It might me valid syntax for the custom resource but a confusing example with unclear purpose.
Such example could make sense if instead of naming one of the default catalog sources, it named a custom catalog source and also provided some context on the custom catalog sources configured on the target cluster. Or maybe it should be split into two distinct examples: one of how to disable all default catalog sources, and another on how to selective disable some of the default catalog sources while leaving others enabled.
Whatever the solution, such examples require some "before/after" listings to show the initial state of the cluster, before applying the custom resource, and after applying.
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.
Research direction
Open operators/understanding/olm-understanding-operatorhub.adoc and review the “Example OperatorHub custom resource” section. Compare the “All default catalog sources” and “community operators” examples, then choose and explain a coherent scenario with the required before-and-after listings. Done when the example’s purpose and resulting catalog-source state are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100