Skip to content

Commit 905d0eb

Browse files
Updating CONTRIBUTING.md accordingly
1 parent c088fe4 commit 905d0eb

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ As you may or may not know, the Operator-Controller project aims to deliver the
1818
The user experience captured in the OLM V1 PRD introduces many requirements that are best satisfied by a microservices architecture. The OLM V1 experience currently relies on two projects:
1919

2020
- [The Operator-Controller project](https://github.com/operator-framework/operator-controller/), which is the top level component allowing users to specify operators they'd like to install.
21-
- [The Catalogd project](https://github.com/operator-framework/catalogd/), which hosts operator content and helps users discover installable content.
21+
- [The Catalogd project](https://github.com/operator-framework/operator-controller/tree/main/catalogd), which hosts operator content and helps users discover installable content.
2222

2323
Each of the projects listed above have their own governance, release milestones, and release cadence. However, from a technical perspective, the "OLM V1 experience" matches the experienced offered by the operator-controller project, the top level component which depends on Catalogd.
2424

@@ -59,6 +59,8 @@ you can follow the steps below to test your changes:
5959
make kind-load kind-deploy
6060
```
6161

62+
**Note** You can use `make run` instead of the above steps.
63+
6264
## How to debug controller tests using ENVTEST
6365

6466
[ENVTEST](https://book.kubebuilder.io/reference/envtest) requires k8s binaries to be downloaded to run the tests.
@@ -120,7 +122,6 @@ As discussed earlier, the operator-controller adheres to a microservice architec
120122
Unsure where to submit an issue?
121123
122124
- [The Operator-Controller project](https://github.com/operator-framework/operator-controller/), which is the top level component allowing users to specify operators they'd like to install.
123-
- [The Catalogd project](https://github.com/operator-framework/catalogd/), which hosts operator content and helps users discover installable content.
124125

125126
Don't worry if you accidentally submit an issue against the wrong project, if we notice that an issue would fit better with a separate project we'll move it to the correct repository and mention it in the #olm-dev slack channel.
126127

0 commit comments

Comments
 (0)