First version for docs versioning

Signed-off-by: Gustavo Fernandes de Carvalho <gustavo.carvalho@container-solutions.com>

.gitignore

@@ -17,7 +17,7 @@ cover.out
 .tagmanifest
 deploy/charts/external-secrets/templates/crds/*.yaml
 
-site/
+#site/
 e2e/k8s/deploy
 e2e/e2e.test
 

Makefile

@@ -190,6 +190,10 @@ helm.generate: helm.docs ## Copy crds to helm chart directory
 docs: generate ## Generate docs
 	$(MAKE) -C ./hack/api-docs build
 
+.PHONY: docs.publish
+docs.publish: generate ## Generate and deploys docs
+	$(MAKE) -C ./hack/api-docs build.publish
+
 .PHONY: serve-docs
 serve-docs: ## Serve docs
 	$(MAKE) -C ./hack/api-docs serve

hack/api-docs/Dockerfile

@@ -18,6 +18,9 @@ RUN apk add -U --no-cache \
     python3 \
     python3-dev \
     musl-dev \
+    git \
+    openssh \
+    git-fast-import \
     bash \
     gcc \
     diffutils \

hack/api-docs/Makefile

@@ -15,6 +15,9 @@
 DOCKER ?= docker
 MKDOCS_IMAGE ?= github.com/external-secrets-mkdocs:latest
 MKDOCS ?= mkdocs
+MIKE ?= mike
+DOCS_VERSION ?= main
+DOCS_ALIAS ?= unstable
 SERVE_BIND_ADDRESS ?= 127.0.0.1
 
 # TOP is the current directory where this Makefile lives.
@@ -45,13 +48,23 @@ image:
 build: image generate $(SOURCES)
 	mkdir -p $(GENROOT)
 	$(DOCKER) run \
-		--mount type=bind,source=$(SRCDIR),target=/docs \
-		--mount type=bind,source=$(CFGFILE),target=/mkdocs.yml \
-		--mount type=bind,source=$(GENROOT),target=/site \
+	    --mount type=bind,source=$(ROOT),target=/repo \
 		--sig-proxy=true \
 		--rm \
+		--user $(UID):$(GID) \
 		$(MKDOCS_IMAGE) \
-		/bin/bash -c "cd / && $(MKDOCS) build; find /site -exec chown $(UID):$(GID) {} \;"
+		/bin/bash -c "cd /repo && git config user.name "Docs" && git config user.email "docs@external-secrets.io" && $(MIKE) deploy --update-aliases -F hack/api-docs/mkdocs.yml $(DOCS_VERSION) $(DOCS_ALIAS);"
+
+.PHONY: build.publish
+build.publish: image generate $(SOURCES)
+	mkdir -p $(GENROOT)
+	$(DOCKER) run \
+	    --mount type=bind,source=$(ROOT),target=/repo \
+		--sig-proxy=true \
+		--rm \
+		--user $(UID):$(GID) \
+		$(MKDOCS_IMAGE) \
+		/bin/bash -c "cd /repo && git config user.name "Docs" && git config user.email "docs@external-secrets.io" && $(MIKE) deploy --update-aliases -p -F hack/api-docs/mkdocs.yml $(DOCS_VERSION) $(DOCS_ALIAS);"
 
 .PHONY: generate
 generate:
@@ -64,14 +77,13 @@ clean:
 # serve runs mkdocs as a local webserver for interactive development.
 # This will serve the live copy of the docs on 127.0.0.1:8000.
 .PHONY: serve
-serve: build
+serve:
 	$(DOCKER) run \
 		-it \
 		--sig-proxy=true \
-		--mount type=bind,source=$(SRCDIR),target=/docs \
-		--mount type=bind,source=$(CFGFILE),target=/mkdocs.yml \
-		--mount type=bind,source=$(GENROOT),target=/site \
+	    --mount type=bind,source=$(ROOT),target=/repo \
+		--user $(UID):$(GID) \
 		-p $(SERVE_BIND_ADDRESS):8000:8000 \
 		--rm \
 		$(MKDOCS_IMAGE) \
-		/bin/bash -c "cd / && $(MKDOCS) serve -a 0.0.0.0:8000"
+		/bin/bash -c "cd /repo && $(MIKE) serve -F hack/api-docs/mkdocs.yml -a 0.0.0.0:8000"

hack/api-docs/mkdocs.yml

@@ -1,10 +1,12 @@
 site_name: External Secrets Operator
 repo_url: https://github.com/external-secrets/external-secrets
 repo_name: External Secrets Operator
-site_dir: site
-docs_dir: docs
+site_dir: ../../site
+docs_dir: ../../docs
+remote_branch: gh-pages-dev
 theme:
   name: material
+  custom_dir: ../../overrides
 markdown_extensions:
   - pymdownx.highlight
   - pymdownx.superfences
@@ -17,6 +19,8 @@ plugins:
   - macros:
       include_dir: docs/snippets
 extra:
+  version:
+    provider: mike
   analytics:
     provider: google
     property: G-QP38TD8K7V

hack/api-docs/requirements.txt

@@ -6,6 +6,7 @@ livereload==2.6.1
 Markdown==3.2.1
 MarkupSafe==1.1.1
 mkdocs==1.1
+mike==1.1.2
 mkdocs-material==7.1.8
 mkdocs-minify-plugin==0.2.1
 pep562==1.0

overrides/index.html

@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block outdated %}
+  You're not viewing the latest version.
+  <a href="{{ '../' ~ base_url }}">
+    <strong>Click here to go to latest.</strong>
+  </a>
+{% endblock %}

site/artifacthub-repo.yml

@@ -0,0 +1 @@
+repositoryID: 0be51c62-4e1d-47d5-b586-3662456e2a89

site/assets/javascripts/lunr/min/lunr.jp.min.js

@@ -0,0 +1 @@
+module.exports=require("./lunr.ja");