From be357c7ee0532e1435cd43686b3777d772409587 Mon Sep 17 00:00:00 2001 From: Alex Jones Date: Mon, 24 Apr 2023 16:40:53 +0200 Subject: [PATCH] updated readme Signed-off-by: Alex Jones --- README.md | 34 +--------------------------------- 1 file changed, 1 insertion(+), 33 deletions(-) diff --git a/README.md b/README.md index def1cf04..56abc3c6 100644 --- a/README.md +++ b/README.md @@ -50,38 +50,6 @@ EOF ## Contributing -// TODO(user): Add detailed information on how you would like others to contribute to this project - -### How it works -This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/). - -It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/), -which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster. - -### Attach from local -1. Install the CRDs into the cluster: - -```sh -make install -``` - -2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running): - -```sh -make run -``` - -**NOTE:** You can also run this in one step by running: `make install run` - -### Modifying the API definitions -If you are editing the API definitions, generate the manifests such as CRs or CRDs using: - -```sh -make manifests -``` - -**NOTE:** Run `make --help` for more information on all potential `make` targets - -More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html) +Please see our community [contributing guidelines](https://github.com/k8sgpt-ai/community) for more information on how to get involved.