From eb54adebaf5bad1e15880c2cc96028165de44a28 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Patryk=20Ma=C5=82ek?= Date: Wed, 27 Mar 2024 12:16:03 +0100 Subject: [PATCH] docs: update README.md with information about adding CRDs to PROJECT (#70) --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a5d08b0d3..0ba78b59d 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ detailed description of how to thoroughly use this project. ### Prerequisites In order to build the operator you'll have to have Go installed on your machine. -In order to do so, follow the instructions on its website][go-dev-site]. +In order to do so, follow the instructions on its website[go-dev-site]. ### Build process @@ -56,6 +56,14 @@ After this step has finished successfully you should see the operator's binary ` You can also run it directly via `make run` which will run the operator on your machine against the cluster that you have configured via your `KUBECONFIG`. +### Adding new CRDs + +Whenever you add a new CRD ensure that it is included in project's [`PROJECT`](./PROJECT) file. + +This is necessary for creation of a bundle for external hubs like [Operator Hub's community operators][community-operators]. + +[community-operators]: https://github.com/k8s-operatorhub/community-operators/ + ## Seeking Help Please search through the posts on the [discussions page][disc] as it's likely