From 8d858621ec6b051c5e372d6ed0bd421639aca996 Mon Sep 17 00:00:00 2001 From: Mateus Oliveira Date: Tue, 26 Mar 2024 15:36:43 -0300 Subject: [PATCH] fixup! fix: Add contribution documenation to project Signed-off-by: Mateus Oliveira --- README.md | 2 ++ docs/CONTRIBUTING.md | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b44fdcf..94e1f63 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,8 @@ This open source controller adds the non admin feature to [OADP operator](https: - Access to a OpenShift cluster - [OADP operator](https://github.com/openshift/oadp-operator) installed in the cluster +> **TODO:** Today, OADP operator must be installed in `openshift-adp` namespace, because of this limitation https://github.com/migtools/oadp-non-admin/blob/master/internal/controller/nonadminbackup_controller.go#L51 + ### Using NAC To use NAC functionality: diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 7926bb5..842c887 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -31,6 +31,8 @@ OADP_NAMESPACE= DEV_IMG= ``` +> **TODO:** If `OADP_NAMESPACE` is set to a value different than `openshift-adp`, you also need to change the value here https://github.com/migtools/oadp-non-admin/blob/master/internal/controller/nonadminbackup_controller.go#L51 + To create a non admin user to test NAC, check [non admin user documentation](non_admin_user.md). To uninstall the previously installed OADP operator in your cluster, run @@ -38,7 +40,7 @@ To uninstall the previously installed OADP operator in your cluster, run make undeploy-dev ``` -> **NOTE:** make sure there are no running instances of CRDs. Finalizers in those objects can fail `undeploy-dev` command. +> **NOTE:** Make sure there are no running instances of CRDs. Finalizers in those objects can fail `undeploy-dev` command. ## Code quality and standardization