Introducing mkdocs generated github pages for etcd-druid documentation (

#909)

Using mkdocs to generate github pages. Some features of mkdocs have been used for better rendering of the docs

.github/workflows/publish-docs.yml

@@ -0,0 +1,29 @@
+name: Publish docs via Github pages
+on:
+  push:
+    branches:
+      - master
+      - mkdocs
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install \
+          mkdocs-material \
+          pymdown-extensions \
+          mkdocs-glightbox \
+          mkdocs-pymdownx-material-extras
+      - run: mkdocs gh-deploy --force

Makefile

@@ -37,9 +37,13 @@ manifests: $(VGOPATH) $(CONTROLLER_GEN)
 	@find "$(REPO_ROOT)/config/crd/bases" -name "*.yaml" -exec cp '{}' "$(REPO_ROOT)/charts/druid/charts/crds/templates/" \;
 	@controller-gen rbac:roleName=manager-role paths="./internal/controller/..."
 
+.PHONY: generate-api-docs
+generate-api-docs: $(CRD_REF_DOCS)
+	@crd-ref-docs --source-path "$(REPO_ROOT)/api" --config "$(HACK_DIR)/api-reference/config.yaml" --output-path "$(REPO_ROOT)/docs/api-reference/etcd-druid-api.md" --renderer markdown
+
 # Generate code
 .PHONY: generate
-generate: manifests $(CONTROLLER_GEN) $(GOIMPORTS) $(MOCKGEN)
+generate: manifests generate-api-docs $(CONTROLLER_GEN) $(GOIMPORTS) $(MOCKGEN)
 	@go generate "$(REPO_ROOT)/internal/..."
 	@"$(HACK_DIR)/update-codegen.sh"
 

README.md

@@ -1,6 +1,6 @@
 <img src="docs/assets/logo/etcd-druid-with-tagline.png" style="width:120%"></img>
 
-[![REUSE status](https://api.reuse.software/badge/github.com/gardener/etcd-druid)](https://api.reuse.software/info/github.com/gardener/etcd-druid) [![CI Build status](https://concourse.ci.gardener.cloud/api/v1/teams/gardener/pipelines/etcd-druid-master/jobs/master-head-update-job/badge)](https://concourse.ci.gardener.cloud/teams/gardener/pipelines/etcd-druid-master/jobs/master-head-update-job) [![Go Report Card](https://goreportcard.com/badge/github.com/gardener/etcd-druid)](https://goreportcard.com/report/github.com/gardener/etcd-druid) [![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE) [![Release](https://img.shields.io/github/v/release/gardener/etcd-druid.svg?style=flat)](https://github.com/gardener/etcd-druid) [![Go Reference](https://pkg.go.dev/badge/github.com/gardener/etcd-druid.svg)](https://pkg.go.dev/github.com/gardener/etcd-druid)
+[![REUSE status](https://api.reuse.software/badge/github.com/gardener/etcd-druid)](https://api.reuse.software/info/github.com/gardener/etcd-druid) [![CI Build status](https://concourse.ci.gardener.cloud/api/v1/teams/gardener/pipelines/etcd-druid-master/jobs/master-head-update-job/badge)](https://concourse.ci.gardener.cloud/teams/gardener/pipelines/etcd-druid-master/jobs/master-head-update-job) [![Go Report Card](https://goreportcard.com/badge/github.com/gardener/etcd-druid)](https://goreportcard.com/report/github.com/gardener/etcd-druid) [![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE) [![Release](https://img.shields.io/github/v/release/gardener/etcd-druid.svg?style=flat)](https://github.com/gardener/etcd-druid) [![Go Reference](https://pkg.go.dev/badge/github.com/gardener/etcd-druid.svg)](https://pkg.go.dev/github.com/gardener/etcd-druid) [![Docs](https://img.shields.io/badge/Docs-reference-orange)](https://gardener.github.io/etcd-druid/index.html)
 
 `etcd-druid` is an [etcd](https://github.com/etcd-io/etcd) [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) which makes it easy to configure, provision, reconcile, monitor and delete etcd clusters. It enables management of etcd clusters through [declarative Kubernetes API model](config/crd/bases/crd-druid.gardener.cloud_etcds.yaml). 
 
@@ -14,7 +14,7 @@ In every etcd cluster managed by `etcd-druid`, each etcd member is a two contain
   - Restoration - In case of a DB corruption for a single-member cluster it helps in restoring from latest set of snapshots (full & delta).
   - Member control operations.
 
-`etcd-druid` additional provides the following capabilities:
+`etcd-druid` additionally provides the following capabilities:
 
 - Facilitates declarative scale-out of [etcd](https://github.com/etcd-io/etcd) clusters.
 - Provides protection against accidental deletion/mutation of resources provisioned as part of an etcd cluster.
@@ -29,7 +29,7 @@ If you are looking to try out druid then you can use a [Kind](https://kind.sigs.
 
 https://github.com/user-attachments/assets/cfe0d891-f709-4d7f-b975-4300c6de67e4
 
-For detailed documentation, see our `/docs` folder. Please find the [index](docs/README.md) here.
+For detailed documentation, see our [docs](https://gardener.github.io/etcd-druid/index.html).
 
 ## Contributions