Skip to content

Commit

Permalink
doc: add source info into README (k8s-operatorhub#452)
Browse files Browse the repository at this point in the history
* doc: add source info into README

Signed-off-by: Camila Macedo <[email protected]>

* Update README.md

Co-authored-by: J0zi <[email protected]>

Co-authored-by: J0zi <[email protected]>
  • Loading branch information
2 people authored and jmesnil committed Jul 26, 2022
1 parent e8c0425 commit 8198d8c
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
## About this repository

This repo is the canonical source for Kubernetes Operators that appear on [OperatorHub.io](https://operatorhub.io).
The solutions merged on this repository are distributed via the [OLM][olm] index catalog [quay.io/operatorhubio/catalog][quay.io].
Users can install [OLM][olm] in any Kubernetes or vendor such as Openshift to consume this content by adding a new CatalogSource for the index image `quay.io/operatorhubio/catalog`. [(more info)][catalog]

## Documentation

Expand All @@ -18,3 +20,6 @@ Full documentation is generated via [mkdoc](https://www.mkdocs.org/) and is loca
Use the issue tracker in this repository to report bugs.

[k8s-deprecated-guide]: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22
[olm]: https://github.com/operator-framework/operator-lifecycle-manager
[quay.io]: https://quay.io/repository/operatorhubio/catalog?tag=latest&tab=tags
[catalog]: https://k8s-operatorhub.github.io/community-operators/testing-operators/#1-create-the-catalogsource

0 comments on commit 8198d8c

Please sign in to comment.