Skip to content

Commit 9ca9c1c

Browse files
committed
Finish off contributing section for OKDerators
1 parent e2b65b8 commit 9ca9c1c

2 files changed

Lines changed: 37 additions & 5 deletions

File tree

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,39 @@
11
# Contribute
22

3-
We are looking for packagers to expand the OKDerator catalog!
3+
We are looking for packagers to expand the OKDerator catalog! The [Directory](directory.md)
4+
lists the operators we would like to offer and which ones still need an owner. Pick one that
5+
interests you, or bring your own suggestion to the `#okd-dev` Slack channel or the OKD
6+
Operators Working Group.
47

5-
:::info
6-
In progress
7-
:::
8+
## How packaging works
9+
10+
Two repositories make up the project:
11+
12+
- [okd-operator-pipeline](https://github.com/okd-project/okd-operator-pipeline) builds the
13+
operator images and OLM bundles from the upstream sources, applying patches where an
14+
operator needs changes to run on OKD.
15+
- [okderators-catalog-index](https://github.com/okd-project/okderators-catalog-index) is the
16+
file-based catalog that clusters consume, with a release branch per OKD version.
17+
18+
Most contributions start in the pipeline repository - its
19+
[CONTRIBUTING.md](https://github.com/okd-project/okd-operator-pipeline/blob/main/CONTRIBUTING.md)
20+
explains how to add a new operator, and
21+
[BUILDING.md](https://github.com/okd-project/okd-operator-pipeline/blob/main/BUILDING.md)
22+
covers building and testing against your own registry. For a walkthrough of the development
23+
process, see the
24+
[OKD Operator Development Overview](https://www.youtube.com/watch?v=_uUNnUWQQ9E) video.
25+
26+
## Other ways to help
27+
28+
Not everything needs a new operator. You can also:
29+
30+
- test packaged operators on your cluster and report issues
31+
- update an existing operator to a newer upstream release
32+
- fill gaps in the [Directory](directory.md) - upstream sources and packaging notes
33+
34+
## Links
35+
36+
- [Build pipeline repository](https://github.com/okd-project/okd-operator-pipeline)
37+
- [Catalog repository](https://github.com/okd-project/okderators-catalog-index)
38+
- [Working group communications](../../community/communications.md) - Slack and mailing lists
39+
- [OKD Operator Development Overview](https://www.youtube.com/watch?v=_uUNnUWQQ9E) - video walkthrough

docs/operators/okderators/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,4 @@ Our choice of operators is currently driven by what's included in the RedHat Ope
5050

5151
## Links
5252
- [Catalog repository](https://github.com/okd-project/okderators-catalog-index)
53-
- [Build pipelines repository](https://github.com/okd-project/okd-operator-pipelines)
53+
- [Build pipeline repository](https://github.com/okd-project/okd-operator-pipeline)

0 commit comments

Comments
 (0)