Merge pull request #1480 from camilamacedo86/add-bug-report

doc: add reporting bugs doc and small nit improvements in the README

README.md

@@ -42,9 +42,11 @@ Operators can behave like managed service providers. Their user interface on the
 
 Install OLM on a Kubernetes or OpenShift cluster by following the [installation guide].
 
-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).
+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).
 
-### User Interface
+**NOTE:** OLM is installed by default in OpenShift 4.0 and above.
+
+## User Interface (Running the console Locally)
 
 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.
 
@@ -56,6 +58,15 @@ $ make run-console-local
 
 Then visit `http://localhost:9000` to view the console.
 
+
+## Contributing your Operator
+
+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/).
+
+## Subscribe to a Package and Channel
+
+Cloud Services can be installed from the catalog by subscribing to a channel in the corresponding package.
+
 **Subscription detail view:**
 ![screenshot_20180628_165240](https://user-images.githubusercontent.com/11700385/42060125-c3cde42c-7af3-11e8-87ec-e5910a554902.png)
 
@@ -143,6 +154,10 @@ To explore any operator samples using the OLM, see the [https://operatorhub.io/]
 
 See the [proposal docs][proposals_docs] and issues for ongoing or planned work.
 
+## Reporting bugs
+
+See [reporting bugs][bug_guide] for details about reporting any issues.
+
 ## License
 
 Operator Lifecycle Manager is under Apache 2.0 license. See the [LICENSE][license_file] file for details.
@@ -158,3 +173,4 @@ Operator Lifecycle Manager is under Apache 2.0 license. See the [LICENSE][licens
 [kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
 [proposals_docs]: ./doc/contributors/design-proposals
 [license_file]:./LICENSE
+[bug_guide]:./doc/dev/reporting_bugs.md

doc/dev/reporting_bugs.md

@@ -0,0 +1,21 @@
+# Reporting bugs
+
+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.
+To make the bug report accurate and easy to understand, please try to create bug reports that are:
+
+- Specific. Include as much details as possible: which version, what environment, what configuration, etc.
+
+- 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.
+
+- 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.
+
+- Unique. Do not duplicate existing bug report.
+
+- Scoped. One bug per report. Do not follow up with another bug inside one report.
+
+It may be worthwhile to read [Elika Etemad’s article on filing good bug reports][filing-good-bugs] before creating a bug report.
+
+We might ask for further information to locate a bug. A duplicated bug report will be closed.
+
+[operator-olm-issue]: https://github.com/operator-framework/operator-lifecycle-manager/issues/new
+[filing-good-bugs]: http://fantasai.inkedblade.net/style/talks/filing-good-bugs/