From 46b6b410f8f1ff82a287714842b1c0adf220ddaf Mon Sep 17 00:00:00 2001 From: Francisc Munteanu Date: Mon, 29 Apr 2024 12:22:58 +0200 Subject: [PATCH] add more details to the api doc (#417) --- README.adoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.adoc b/README.adoc index 8cc0a8c4..5372d9c3 100644 --- a/README.adoc +++ b/README.adoc @@ -18,3 +18,6 @@ make generate ``` NOTE: the `make generate` will generate the CRD files in the local `config/crd/bases` directory and then dispatch the `.yaml` files in the `host-operator` and `member-operator` repositories, assuming they have been checked out and that *they are in a clean state*, meaning that they have no pending changes, besides previous versions of the CRD files. + +NOTE: Then you are supposed to create PRs also in the repos where the change was propagated ( host | member-operator ). Please do not mix other changes to the code with those CRD changes. While it would work technically , it’s always preferred to promote the CRD changes separately for easier PR review. +