From d478d30ad3303ce93010db23c2c2bd493a955b0e Mon Sep 17 00:00:00 2001 From: Alexander Greene Date: Mon, 3 Apr 2023 07:21:41 -0700 Subject: [PATCH] Reference PRD and CONTRIBUTING.md in the README.md This commit updates the README.md to provide links to the CONTRIBUTING.md and Product Requirements Document and addresses a spelling mistake. Signed-off-by: Alexander Greene --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 741e84137..29dce3cfe 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,16 @@ The operator-controller is the central component of Operator Lifecycle Manager (OLM) v1. It extends Kubernetes with an API through which users can install Operators. ## Description -OLM v1 is the follow-up to OLM v0, located [here](https://github.com/operator-framework/operator-lifecycle-manager). It consists of four different components, including this one, which are as follows: +OLM v1 is the follow-up to [OLM v0](https://github.com/operator-framework/operator-lifecycle-manager). The vision for OLM V1 is discussed in detail in the [OLM V1 Product Requirements Document](https://docs.google.com/document/d/1-vsZ2dAODNfoHb7Nf0fbYeKDF7DUqEzS9HqgeMCvbDs/edit). + +The Operator Controller project consists of four different components, including this one, which are as follows: * operator-controller * [deppy](https://github.com/operator-framework/deppy) * [rukpak](https://github.com/operator-framework/rukpak) * [catalogd](https://github.com/operator-framework/catalogd) +Ongoing feature development can always be tracked at the [OLM V1 GitHub Project](https://github.com/orgs/operator-framework/projects/8) by looking at `Milestone #` tabs. + ## Getting Started You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster. **Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows). @@ -46,7 +50,7 @@ make undeploy ``` ## Contributing -// TODO(user): Add detailed information on how you would like others to contribute to this project +If you are interested in getting involved, please see the [CONTRIBUTING.md](TO/Be/Added) for more information. ### How it works This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)