Skip to content

Commit 56a72a9

Browse files
camilamacedo86ankitathomas
authored andcommitted
doc: add reporting bugs doc and small nit improvements in the README
(upstream operator-lifecycle-manager commit: c34230d28ec36d3e081472c5985e02192c7bcfe8)
1 parent 377d391 commit 56a72a9

File tree

2 files changed

+41
-1
lines changed

2 files changed

+41
-1
lines changed

staging/operator-lifecycle-manager/README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,9 @@ Install OLM on a Kubernetes or OpenShift cluster by following the [installation
4444

4545
For a complete end-to-end example of how OLM fits into the Operator Framework, see the [Operator Framework Getting Started Guide](https://github.com/operator-framework/getting-started).
4646

47-
### User Interface
47+
**NOTE:** OLM is installed by default in OpenShift 4.0 and above.
48+
49+
## User Interface (Running the console Locally)
4850

4951
Use the OpenShift admin console (compatible with upstream Kubernetes) to interact with and visualize the resources managed by OLM. Create subscriptions, approve install plans, identify Operator-managed resources, and more.
5052

@@ -56,6 +58,18 @@ $ make run-console-local
5658

5759
Then visit `http://localhost:9000` to view the console.
5860

61+
## End-to-end example
62+
63+
For a complete end-to-end example of how OLM fits into the Operator Framework, see the [Operator Framework Getting Started Guide](https://github.com/operator-framework/getting-started). Also, see [Getting Started on OperatorHub.io](https://operatorhub.io/getting-started).
64+
65+
## Contributing your Operator
66+
67+
Have an awesome Operator you want to share? Checkout the [publishing docs](https://operatorhub.io/contribute) to learn about contributing to [OperatorHub.io](https://operatorhub.io/).
68+
69+
## Subscribe to a Package and Channel
70+
71+
Cloud Services can be installed from the catalog by subscribing to a channel in the corresponding package.
72+
5973
**Subscription detail view:**
6074
![screenshot_20180628_165240](https://user-images.githubusercontent.com/11700385/42060125-c3cde42c-7af3-11e8-87ec-e5910a554902.png)
6175

@@ -143,6 +157,10 @@ To explore any operator samples using the OLM, see the [https://operatorhub.io/]
143157

144158
See the [proposal docs][proposals_docs] and issues for ongoing or planned work.
145159

160+
## Reporting bugs
161+
162+
See [reporting bugs][bug_guide] for details about reporting any issues.
163+
146164
## License
147165

148166
Operator Lifecycle Manager is under Apache 2.0 license. See the [LICENSE][license_file] file for details.
@@ -158,3 +176,4 @@ Operator Lifecycle Manager is under Apache 2.0 license. See the [LICENSE][licens
158176
[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
159177
[proposals_docs]: ./doc/contributors/design-proposals
160178
[license_file]:./LICENSE
179+
[bug_guide]:./doc/dev/reporting_bugs.md
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Reporting bugs
2+
3+
If any part of the operator-lifecycle-manager project has bugs or documentation mistakes, please let us know by [opening an issue][operator-olm-issue]. We treat bugs and mistakes very seriously and believe no issue is too small. Before creating a bug report, please check that an issue reporting the same problem does not already exist.
4+
To make the bug report accurate and easy to understand, please try to create bug reports that are:
5+
6+
- Specific. Include as much details as possible: which version, what environment, what configuration, etc.
7+
8+
- Reproducible. Include the steps to reproduce the problem. We understand some issues might be hard to reproduce, please include the steps that might lead to the problem.
9+
10+
- Isolated. Please try to isolate and reproduce the bug with minimum dependencies. It would significantly slow down the speed to fix a bug if too many dependencies are involved in a bug report. Debugging external systems that rely on operator-lifecycle-manager is out of scope, but we are happy to provide guidance in the right direction or help with using operator-lifecycle-manager itself.
11+
12+
- Unique. Do not duplicate existing bug report.
13+
14+
- Scoped. One bug per report. Do not follow up with another bug inside one report.
15+
16+
It may be worthwhile to read [Elika Etemad’s article on filing good bug reports][filing-good-bugs] before creating a bug report.
17+
18+
We might ask for further information to locate a bug. A duplicated bug report will be closed.
19+
20+
[operator-olm-issue]: https://github.com/operator-framework/operator-lifecycle-manager/issues/new
21+
[filing-good-bugs]: http://fantasai.inkedblade.net/style/talks/filing-good-bugs/

0 commit comments

Comments
 (0)