docs: updated docs

Author: mahendraintelops

CONTRIBUTING.md

@@ -8,29 +8,33 @@ If you find a bug while working with the Compage, please [open an issue on GitHu
 You are more than welcome to open issues in this project to [suggest new features](https://github.com/intelops/compage/issues/new?labels=kind%2Ffeature&template=feature-request.md&title=Feature%20Request:).
 
 ## Contributing Code
-This project is written in Golang, NodeJs(TypeScript) and ReactJs(TypeScript). 
+This project is written in Golang, Node.js(TypeScript) and ReactJs(TypeScript). 
 
 ![block-diagram.png](images/architecture-high.png)
 
-To contribute code,
+To contribute code.
 1. Ensure you are running golang version 1.11.4 or greater for go module support
 2. Set the following environment variables:
     ```
     GO111MODULE=on
     GOFLAGS=-mod=vendor
     ```
-3. Ensure you have NodeJs(LTS >= 18.12.0) installed for Core and UI part of the compage.
-4. Ensure you have access to any Kubernetes(tested on KinD) cluster to store the compage projects and users related data on it.
+3. Ensure you have Node.js(LTS >= 18.12.0) installed for Core and UI part of the compage.
+4. Ensure you have access to any Kubernetes (tested on KinD) cluster to store the compage projects and users related data on it.
    #### KinD
    - Install KinD from https://kind.sigs.k8s.io/docs/user/quick-start/#installing-from-release-binaries
-   - Create KinD cluster https://kind.sigs.k8s.io/docs/user/quick-start/#creating-a-cluster
+   - Create KinD cluster using below command
+     ```shell
+     cd deploy
+     ./create-kind-cluster.sh
+     ```
    - Check if you can access the cluster created in previous step, and you are able to list down the pods.
 5. Fork the project.
 6. Clone the project: `git clone https://github.com/[YOUR_USERNAME]/compage && cd compage`
 7. kindly refer compage.md file to know the structure of the project.
-8. The Compage has 3 servers (subprojects) which need to be started to run the compage on local
+8. The Compage has three servers (subprojects) which need to be started to run the compage on local
    - core (Golang), navigate to core directory and follow its [core README](./core/README.md)
-   - app (NodeJs), navigate to app directory and follow its [app README](./app/README.md)
+   - app (Node.js), navigate to app directory and follow its [app README](./app/README.md)
    - ui (ReactJs), navigate to ui directory and follow its [ui README](./ui/README.md)
 9. Commit changes *([Please refer the commit message conventions](https://www.conventionalcommits.org/en/v1.0.0/))*
 10. Push commits.
@@ -49,9 +53,9 @@ The documentation is contained within `./docs` and made with Docusaurus. See the
    ```shell
   export PATH="$PATH:$(go env GOPATH)/bin"
    ```
-- Download buf binary from this link - https://github.com/bufbuild/buf/releases and fire the command from core directory of compage.
+- Download buf binary from this link—https://github.com/bufbuild/buf/releases and fire the command from core directory of compage.
    ```shell
    buf generate
    ```
-## How K8s and GitHub are interacted with above 3 components?
+## How are K8s and GitHub interacted with above three components?
 ![architecture-med.png](images/architecture-med.png)

deploy/README.md

@@ -43,13 +43,13 @@
 
 ## Different shell scripts in deploy directory.
 ### create-kind-cluster.sh
-- creates KinD cluster, creates `compage` namespace on it and sets `compage` namespace as default. It later extracts KinD cluster's node ip as well and sets it to KIND_NODE_IP environment variable.
+- This script creates KinD cluster, creates `compage` namespace on it and sets `compage` namespace as default. It later extracts KinD cluster's node ip as well and sets it to KIND_NODE_IP environment variable.
  
 ### delete-kind-cluster.sh
-- deletes the KinD cluster.
+- This script deletes the KinD cluster.
 
 ### load-on-kind.sh
 - creates KinD cluster, builds docker images for core, app and ui components of compage. The images are then loaded on to KinD cluster. 
 
 ### push-docker-images-to-github.sh
-- builds docker images for core, app and ui components of compage. The images are then pushed to configured docker registry.
+- This script builds docker images for core, app and ui components of compage. The images are then pushed to configured docker registry.

deploy/steps.md

@@ -1,47 +1,66 @@
-### Steps to create a cassandra cluster on k8s using k8ssandra operator
+### Steps to install compage with local cassandra cluster on k8s using k8ssandra operator
+```shell
 ./create-kind-cluster.sh
 
-helm repo add k8ssandra https://helm.k8ssandra.io/stable
-helm repo update
+### install cert-manager
 helm repo add jetstack https://charts.jetstack.io
 helm repo update
 helm install cert-manager jetstack/cert-manager --namespace cert-manager --create-namespace --set installCRDs=true
+
+### install k8ssandra operator
+helm repo add k8ssandra https://helm.k8ssandra.io/stable
+helm repo update
 helm install k8ssandra-operator k8ssandra/k8ssandra-operator -n k8ssandra-operator --set global.clusterScoped=true --create-namespace
 
+### create cassandra cluster
 kubectl apply -n k8ssandra-operator -f k8sc.yml
 kubectl get pods -n k8ssandra-operator
 kubectl describe k8cs test -n k8ssandra-operator
+
+### Get cassandra username and password
 CASS_USERNAME=$(kubectl get secret test-superuser -n k8ssandra-operator -o=jsonpath='{.data.username}' | base64 --decode)
 echo $CASS_USERNAME
 CASS_PASSWORD=$(kubectl get secret test-superuser -n k8ssandra-operator -o=jsonpath='{.data.password}' | base64 --decode)
 echo $CASS_PASSWORD
+
+### Connect to cassandra cluster
 kubectl exec -it test-dc1-default-sts-0 -n k8ssandra-operator -- /bin/bash
 cqlsh -u test-superuser -p $CASS_PASSWORD
 
 ### Fire ddl commands in ddl.sql
+```
 ### Fire below commands to install ingress controller
+```shell
 kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/deploy/static/provider/kind/deploy.yaml
 kubectl wait --namespace ingress-nginx --for=condition=ready pod --selector=app.kubernetes.io/component=controller --timeout=90s
+```
 
 ### Create namespace
+```shell
 kubectl create ns compage
 kubens compage
-
-### Create docker images
+```
+### Create docker images [optional if you are installing public chart, you can skip this step. You just need to build the ui docker image and load it into kind cluster]
+```shell
 ./build-docker-images.sh
+```
 
 ### Load docker images into kind cluster
+```shell
 kind load docker-image --name compage ghcr.io/intelops/compage/app:v1Next
 kind load docker-image --name compage ghcr.io/intelops/compage/core:v1Next
 kind load docker-image --name compage ghcr.io/intelops/compage/ui:v1Next
+```
 
 ### Update image tags and cassandra password in values.yaml
-### Install compage helm chart from compage root directory
+#### Install compage helm chart from compage root directory
+```shell
 helm install compage charts/compage --values charts/compage/values.yaml
-
-### wait for pods to be ready
+```
+#### wait for pods to be ready
+```shell
 watch kubectl get pods -n compage
-
+```
 ## Common issues
-https://www.scmgalaxy.com/tutorials/kubernetes-error-1-no-preemption-victims-found-for-incoming-pod/#:~:text=The%20error%20message%20%E2%80%9C0%2F1,to%20meet%20the%20pod's%20requirements.
-https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files
+- https://www.scmgalaxy.com/tutorials/kubernetes-error-1-no-preemption-victims-found-for-incoming-pod/
+- https://kind.sigs.k8s.io/docs/user/known-issues/#pod-errors-due-to-too-many-open-files