Update docs to use new operator name (#7)

* Update docs to use new operator name

* Remove code of conduct

Author: Kenny Scharm

Makefile

@@ -34,7 +34,7 @@ buildlinux-%: ${SOURCES}
 	CGO_ENABLED=0 GOOS=linux go build -installsuffix cgo ${LDFLAGS} -o docker/$*/$* ./cmd/$*/main.go
 
 container-%: buildlinux-%
-	docker build -t $(PREFIX)icm-redis-$*:$(TAG) -f Dockerfile.$* .
+	docker build -t $(PREFIX)$*-for-redis:$(TAG) -f Dockerfile.$* .
 
 build: $(addprefix build-,$(CMDBINS))
 
@@ -70,7 +70,7 @@ test:
 	./go.test.sh
 
 push-%: container-%
-	docker push $(PREFIX)icm-redis-$*:$(TAG)
+	docker push $(PREFIX)$*-for-redis:$(TAG)
 
 push: $(addprefix push-,$(CMDBINS))
 

charts/node-for-redis/Chart.yaml

@@ -3,7 +3,7 @@ name: node-for-redis
 type: application
 version: 0.0.0     # Overridden by release workflow
 appVersion: 0.0.0  # Overridden by release workflow
-description: IBM Cluster for interfacing with Redis
+description: Cluster node for interfacing with Redis
 maintainers:
   - name: tomashibm  # Tomash Sidei
   - name: cin        # Craig Ingram

charts/operator-for-redis/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: operator-for-redis
 type: application
 version: 0.0.0  # Overridden by release workflow
-description: IBM Operator for creating and managing Redis clusters
+description: Operator for creating and managing Redis clusters
 maintainers:
   - name: tomashibm  # Tomash Sidei
   - name: cin        # Craig Ingram

docs/docs/CODE_OF_CONDUCT.md

@@ -5,8 +5,6 @@ slug: /contributing
 
 # Contributing
 
-By participating in this project, you agree to our [code of conduct](CODE_OF_CONDUCT.md).
-
 ## Set up your machine
 
 Refer to our [cookbook](cookbook.md#installation) to learn how to set up your machine.

docs/docs/CONTRIBUTING.md

@@ -7,7 +7,7 @@ slug: /cookbook
 
 ## Installation
 
-Redis operator is written in [Go](https://golang.org/).
+Operator for Redis Cluster is written in [Go](https://golang.org/).
 
 ### Required Dependencies
 
@@ -23,7 +23,7 @@ Redis operator is written in [Go](https://golang.org/).
 
 ### Download and build the source code
 
-Start by making a fork of the `redis-operator` repository. Then, clone your forked repo:
+Start by making a fork of the `operator-for-redis-cluster` repository. Then, clone your forked repo:
 
 ```console
 $ git clone [email protected]:<YOUR_USERNAME>/operator-for-redis-cluster.git
@@ -76,16 +76,16 @@ make container PREFIX= TAG=latest
 
 Once the kind cluster is up and running, load the images into the kind cluster:
 ```console
-$ kind load docker-image operator-for-redis-cluster:latest
-$ kind load docker-image icm-redis-node:latest
-$ kind load docker-image icm-redis-metrics:latest
+$ kind load docker-image operator-for-redis:latest
+$ kind load docker-image node-for-redis:latest
+$ kind load docker-image metrics-for-redis:latest
 ```
 
 ### Deploy a Redis operator
 
-Install the `operator-for-redis-cluster` Helm chart:
+Install the `operator-for-redis` Helm chart:
 ```console
-$ helm install op charts/operator-for-redis-cluster --wait --set image.repository=operator-for-redis-cluster --set image.tag=latest
+$ helm install op charts/operator-for-redis --wait --set image.repository=operator-for-redis --set image.tag=latest
 NAME: op
 LAST DEPLOYED: Thu Oct 21 15:11:51 2021
 NAMESPACE: default
@@ -99,14 +99,14 @@ Confirm that the operator is running properly:
 ```console
 $ kubectl get pods
 NAME                                     READY   STATUS    RESTARTS   AGE
-op-operator-for-redis-cluster-64dbfb4b59-xjttw   1/1     Running   0          31s
+op-operator-for-redis-64dbfb4b59-xjttw   1/1     Running   0          31s
 ```
 
 ### Deploy a Redis cluster
 
 Install the `node-for-redis` Helm chart:
 ```console
-$ helm install --wait cluster charts/node-for-redis --set image.repository=icm-redis-node --set image.tag=latest
+$ helm install --wait cluster charts/node-for-redis --set image.repository=node-for-redis --set image.tag=latest
 NAME: cluster
 LAST DEPLOYED: Thu Oct 21 15:12:05 2021
 NAMESPACE: default
@@ -162,14 +162,14 @@ Note that we need both `local` and `new` image tags for a rolling update e2e tes
 
 Load the required images into the kind cluster:
 ```console
-$ kind load docker-image operator-for-redis-cluster:local
-$ kind load docker-image icm-redis-node:local
-$ kind load docker-image icm-redis-node:new
+$ kind load docker-image operator-for-redis:local
+$ kind load docker-image node-for-redis:local
+$ kind load docker-image node-for-redis:new
 ```
 
-Once the kind cluster is up and running, deploy the `operator-for-redis-cluster` Helm chart:
+Once the kind cluster is up and running, deploy the `operator-for-redis` Helm chart:
 ```console
-$ helm install op charts/operator-for-redis-cluster --wait --set image.repository=operator-for-redis-cluster --set image.tag=local
+$ helm install op charts/operator-for-redis --wait --set image.repository=operator-for-redis --set image.tag=local
 NAME: op
 LAST DEPLOYED: Thu Oct 21 15:11:51 2021
 NAMESPACE: default
@@ -178,7 +178,7 @@ REVISION: 1
 TEST SUITE: None
 ```
 
-When the `operator-for-redis-cluster` pod is up and running, you can start the e2e regression:
+When the `operator-for-redis` pod is up and running, you can start the e2e regression:
 ```console
 $ go test -timeout 30m ./test/e2e --kubeconfig=$HOME/.kube/config --ginkgo.v --test.v
 Running Suite: RedisCluster Suite

docs/docs/cookbook.md

@@ -18,9 +18,9 @@ This project contains two Helm charts, namely `operator-for-redis` and `node-for
 
 ![Initial state](../static/images/overview_1.png)
 
-At this point, your Redis process is running and each node is aware of each other, but only one primary has all the slots. In order to properly configure each node in the cluster, we introduce the `Redis Operator`.
+At this point, your Redis process is running and each node is aware of each other, but only one primary has all the slots. In order to properly configure each node in the cluster, we introduce the `Operator for Redis Cluster`.
 
-The `Redis Operator` watches the `RedisCluster` CR that stores cluster configuration: number of primaries, replication factor (number of replicas per primary), and the pod template. Then the operator tries to apply this configuration to the set of Redis server processes. If the number of Redis servers doesn't match the provided configuration, the manager scales the number of pods to obtain the proper number of Redis nodes. The operator continuously reconciles the state of the cluster with the configuration stored in the `RedisCluster` CR until they match. To understand how the reconciliation loop works, see the [Operator SDK docs](https://sdk.operatorframework.io/docs/building-operators/golang/tutorial/#reconcile-loop).
+The operator watches the `RedisCluster` CR that stores cluster configuration: number of primaries, replication factor (number of replicas per primary), and the pod template. Then the operator tries to apply this configuration to the set of Redis server processes. If the number of Redis servers doesn't match the provided configuration, the manager scales the number of pods to obtain the proper number of Redis nodes. The operator continuously reconciles the state of the cluster with the configuration stored in the `RedisCluster` CR until they match. To understand how the reconciliation loop works, see the [Operator SDK docs](https://sdk.operatorframework.io/docs/building-operators/golang/tutorial/#reconcile-loop).
 
 ## Deployment
 
@@ -44,16 +44,16 @@ You can find two Helm charts in the `charts` folder:
 
 Operator deployment example:
 ```console
-helm install operator-for-redis-cluster charts/operator-for-redis-cluster
-NAME: operator-for-redis-cluster
+helm install operator-for-redis charts/operator-for-redis
+NAME: operator-for-redis
 LAST DEPLOYED: Fri Aug 13 11:48:29 2021
 NAMESPACE: default
 STATUS: deployed
 
 RESOURCES:
 ==> v1/Deployment
 NAME                DESIRED  CURRENT  UP-TO-DATE  AVAILABLE  AGE
-operator-for-redis-cluster  1        1        1           1          10s
+operator-for-redis  1        1        1           1          10s
 ```
 
 #### Create the RedisCluster

docs/docs/home.md

@@ -2,7 +2,7 @@ const isCI = !!process.env.CI;
 
 /** @type {import('@docusaurus/types').DocusaurusConfig} */
 module.exports = {
-  title: 'IBM Operator for Redis Cluster',
+  title: 'Operator for Redis Cluster',
   url: isCI ? 'https://ibm.github.io' : 'http://localhost:3001',
   baseUrl: '/operator-for-redis-cluster/',
   onBrokenLinks: 'throw',
@@ -38,7 +38,7 @@ module.exports = {
     footer: {
       style: 'dark',
       links: [],
-      copyright: `IBM Operator for Redis Cluster Documentation. Built with Docusaurus.`,
+      copyright: `Operator for Redis Cluster Documentation. Built with Docusaurus.`,
     },
   },
   presets: [

docs/docusaurus.config.js

@@ -19,6 +19,5 @@ module.exports = {
     'rolling-update',
     'key-migration',
     'CONTRIBUTING',
-    'CODE_OF_CONDUCT',
   ],
 };

docs/sidebars.js

@@ -4,7 +4,7 @@ entries:
   - apiVersion: v2
     appVersion: 6.2.6
     created: "2022-01-06T22:09:58.04939947Z"
-    description: IBM Cluster for interfacing with Redis
+    description: Cluster node for interfacing with Redis
     digest: 449a7fbe5164d6dca34426837f578420d7fa56280fc61b574fbd1f094cd99f8c
     maintainers:
     - name: tomashibm
@@ -19,7 +19,7 @@ entries:
   - apiVersion: v2
     appVersion: 6.2.6
     created: "2022-01-06T22:09:58.048123653Z"
-    description: IBM Cluster for interfacing with Redis
+    description: Cluster node for interfacing with Redis
     digest: cee77ec7fdb4276d24a02c62f672c0769fc153ebfd69d944a40930b04a5794c7
     maintainers:
     - name: tomashibm
@@ -34,7 +34,7 @@ entries:
   operator-for-redis:
   - apiVersion: v2
     created: "2022-01-06T22:09:58.056363963Z"
-    description: IBM Operator for creating and managing Redis clusters
+    description: Operator for creating and managing Redis clusters
     digest: 2bc14cd0b4ed461de70c9a55fc684b9c9d863f1ed05402427321f26d51febce6
     maintainers:
     - name: tomashibm
@@ -48,7 +48,7 @@ entries:
     version: 0.3.6
   - apiVersion: v2
     created: "2022-01-06T22:09:58.053555926Z"
-    description: IBM Operator for creating and managing Redis clusters
+    description: Operator for creating and managing Redis clusters
     digest: f1eb5062bb0399d35efa12bea03a4464387846795fd918915d9c55197961e21c
     maintainers:
     - name: tomashibm