Create overview doc

unagex · Feb 9, 2024 · 6ebc3f5 · 6ebc3f5
1 parent 2b99232
commit 6ebc3f5
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 1 deletion.
diff --git a/docs/haha.png b/docs/haha.png
diff --git a/docs/overview.md b/docs/overview.md
@@ -1 +1,12 @@
-# Operator Overview
+# Operator Overview
+The operator watches for `Immudb resources` to be created. See the default behavior in the diagram below.
+<br></br>
+<!-- ![overview](./overview.svg) -->
+<div style="text-align: center;">
+<img src="./overview.svg" alt="overview" style="max-width:300px;height: auto;">
+</div>
+<br></br>
+
+## **Pro Tips :bulb:**
+1. Deleting the `immudb resource` deletes the database and all its associated resources (services, persistantVolumeClaim, ...).
+2. 
diff --git a/docs/overview.svg b/docs/overview.svg