Update doc architecture

unagex · Feb 8, 2024 · 117b3c9 · 117b3c9
1 parent 1486230
commit 117b3c9
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -23,9 +23,10 @@ helm install immudb-operator immudb-operator-charts/immudb-operator
 ```
 kubectl apply -f https://raw.githubusercontent.com/unagex/immudb-operator/main/config/samples/v1_immudb.yaml
 ```
+⬇ See documentation below for more options ⬇
 
 ## Documentation
 
-* [Installation](./docs/installation.md)
-* [Configuration](./docs/configuration.md)
+* [Operator Installation](./docs/installation.md)
+* [Immudb Configuration](./docs/configuration.md)
 * [Contribution](./docs/contribution.md)
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -1 +1 @@
-# Configuration
+# Immudb Configuration
diff --git a/docs/contribution.md b/docs/contribution.md
@@ -3,9 +3,11 @@
 Thanks for taking the time to contribute to immudb-operator.
 
 ## How to make PR
+
 You can create a PR into `main` when your feature is ready. We will review it within 2 days.
 
 ## Local development with minikube
+
 1. To try a new feature, first create a minikube cluster.
 ```bash
 minikube start
@@ -22,7 +24,6 @@ make install run
 ```
 You should see the following log:
 ![image](./local-dev.png)
-
 5. The operator is now running on minikube, you can create the custom resource and see how the operator handles it.
 ```bash
 kubectl apply -f config/samples/v1_immudb.yaml

diff --git a/docs/installation.md b/docs/installation.md
@@ -1,4 +1,4 @@
-# Installation
+# Operator Installation
 
 - [Install on Minikube](#install-on-minikube)
 - [Install on Amazon Elastic Kubernetes Service (EKS)](#install-on-amazon-elastic-kubernetes-service-eks)