From 905d0ebdb92cd8c7ae25fc03a84812f5167b5ea0 Mon Sep 17 00:00:00 2001 From: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com> Date: Tue, 14 Jan 2025 12:45:53 +0000 Subject: [PATCH] Updating CONTRIBUTING.md accordingly --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e7c1607e..73d380f07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ As you may or may not know, the Operator-Controller project aims to deliver the 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: - [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. -- [The Catalogd project](https://github.com/operator-framework/catalogd/), which hosts operator content and helps users discover installable content. +- [The Catalogd project](https://github.com/operator-framework/operator-controller/tree/main/catalogd), which hosts operator content and helps users discover installable content. 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. @@ -59,6 +59,8 @@ you can follow the steps below to test your changes: make kind-load kind-deploy ``` +**Note** You can use `make run` instead of the above steps. + ## How to debug controller tests using ENVTEST [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 Unsure where to submit an issue? - [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. -- [The Catalogd project](https://github.com/operator-framework/catalogd/), which hosts operator content and helps users discover installable content. 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.