WIP: Start writing the 'getting started' page

Signed-off-by: Nikolai Rodionov <allanger@badhouseplants.net>

Author: allanger

docs/development/contribution.md

@@ -0,0 +1,5 @@
+# How to contribute
+
+## Workflow
+
+## How to become a maintainer

docs/development/helm-charts.md

@@ -25,4 +25,3 @@ yq -i '.appVersion = "${GIT_SHA}"' ./charts/db-operator/Chart.yaml
 ```
 
 After that, CRDs will be up-to-date with the operator repo and you can test your changes.
-##

docs/index.md

@@ -1,5 +1,43 @@
 # Getting Started
 
+DB Operator is a Kubernetes operator for managing **MySQL** and **PostgreSQL** databases through **CRDs**.
+
+This operator doesn't launch databases, instead it should be connected to running servers, that's why it doesn't nececeraly require that the database is running in Kubernetes, and can be used with any server that can be accessed from inside the cluster.
+
+After it is connected to a server, you can start managing databases and users through CRDs. When a user or a database is created, db-operator will add a `Secret` and a `ConfigMap` to the namespace where CR is deployed, they can be used by a pod to establish a connection with a database.
+
+### Example
+
+Let's imagine, you have an application that requires a connection to a Postgres DB, it receives credentials from the environment variable `POSTGRES_DATASOURCE`, and it needs to be in a following format: `postgresql://${USER}:${PASSWORD}@${HOSTNAME}:${PORT}/${DATABASE}?search_path=myapp`
+
+We will talk about how to install the operator and connect it to a server later, now let's focus on the main logic. We need to create a `Database` resource:
+```yaml
+apiVersion: kinda.rocks/v1beta1
+kind: Database
+metadata:
+  name: my-app
+  namespace: my-namespace
+spec:
+  backup:
+    enable: false
+  credentials:
+    templates:
+    # - This template will be used by the operator to add POSTGRES_DATASOURCE to the secret.
+    # - TODO(@allanger): Add a link to the templates docs
+    - name: POSTGRES_DATASOURCE
+      secret: true
+      template: '{{ .Protocol }}://{{ .Username }}:{{ .Password }}@{{ .Hostname }}:{{ .Port }}/{{ .Database }}?search_path=my-app'
+  deletionProtected: true
+  instance: some-postgres
+  postgres:
+    dropPublicSchema: true
+    schemas:
+    - my-app
+  secretName: my-app-db-creds
+```
+
+> (@allanger): This logic might be changed when the `Database` resource will be upgrade to the version `v1`
+After the reconciliation you should be able to find a `ConfigMap` and a `Secret` in the namespace `my-namespace`. They both will be called `my-app-db-creds`
 
 
 ## Install db-operator

mkdocs.yml

@@ -2,3 +2,5 @@ site_name: DB Operator
 theme:
   name: material
   language: en
+  features:
+    - navigation.tabs