[Task] Update secrets docs with submodule mkdocs SA 5304 (#27)

* Updated secrets docs with git submodule mkdocs theme common

* Removed tracking for mkdocs yml root file as it is originated at the run time

* Updated github workflows and prepare theme shell script and gitignore

* Replaced dead links with the working one

* Shifted footer logos to theme common

* Updated the theme override

* Updated theme common

* Updated theme common

.github/workflows/pull_request.yaml

@@ -3,17 +3,17 @@ name: Pull Request
 on:
   pull_request:
     branches:
-      - 'main'
+      - "main"
 
 jobs:
   qa:
-    uses: stakater/.github/.github/workflows/[email protected].71
+    uses: stakater/.github/.github/workflows/[email protected].75
     with:
       MD_CONFIG: .github/md_config.json
       DOC_SRC: content
       MD_LINT_CONFIG: .markdownlint.yaml
   build:
-    uses: stakater/.github/.github/workflows/[email protected].71
+    uses: stakater/.github/.github/workflows/[email protected].75
     with:
       DOCKER_FILE_PATH: Dockerfile
     secrets:

.github/workflows/push.yaml

@@ -3,11 +3,11 @@ name: Push
 on:
   push:
     branches:
-      - 'main'
+      - "main"
 
 jobs:
   push:
-    uses: stakater/.github/.github/workflows/[email protected].71
+    uses: stakater/.github/.github/workflows/[email protected].75
     with:
       DOCKER_FILE_PATH: Dockerfile
       RELEASE_BRANCH: main

.github/workflows/release.yaml

@@ -7,6 +7,6 @@ on:
 
 jobs:
   release:
-    uses: stakater/.github/.github/workflows/[email protected].71
+    uses: stakater/.github/.github/workflows/[email protected].75
     secrets:
       SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }}

.gitignore

@@ -21,3 +21,6 @@ node_modules
 # Build files
 site/
 styles/
+
+# yml files
+mkdocs.yml

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "theme_common"]
+	path = theme_common
+	url = [email protected]:stakater/stakater-docs-mkdocs-theme.git

Dockerfile

@@ -1,6 +1,6 @@
 FROM python:3.12-alpine as builder
 
-RUN pip3 install mkdocs-material mkdocs-mermaid2-plugin
+RUN pip3 install mkdocs-mermaid2-plugin mkdocs-table-reader-plugin mkdocs-include-markdown-plugin
 
 # set workdir
 RUN mkdir -p $HOME/application
@@ -10,6 +10,7 @@ WORKDIR $HOME/application
 COPY --chown=1001:root . .
 
 # build the docs
+RUN chmod +x prepare_theme.sh && ./prepare_theme.sh
 RUN mkdocs build
 
 FROM nginxinc/nginx-unprivileged:1.26-alpine as deploy

content/external-secret-operator/workflow.md

@@ -16,7 +16,7 @@ Secret Store `tenant-vault-secret-store` is already created in each namespace by
 
 ### Step 3
 
-Service account `tenant-vault-access` being referred by `SecretStore` is already created by Multi Tenant Operator templates. This service account has the `stakater.com/vault-access: 'true'` label, which is used to bound it with the Vault `role` by Multi Tenant Operator. To learn how Multi Tenant Operator authenticates with Vault, see [Vault Multitenancy](https://docs.stakater.com/mto/latest/tutorials/vault/enabling-multi-tenancy-vault.html).
+Service account `tenant-vault-access` being referred by `SecretStore` is already created by Multi Tenant Operator templates. This service account has the `stakater.com/vault-access: 'true'` label, which is used to bound it with the Vault `role` by Multi Tenant Operator. To learn how Multi Tenant Operator authenticates with Vault, see [Vault Multitenancy](https://docs.stakater.com/mto/latest/how-to-guides/enabling-multi-tenancy-vault.html).
 
 ### Step 4
 

prepare_theme.sh

@@ -0,0 +1,3 @@
+pip install -r theme_common/requirements.txt
+python theme_common/scripts/combine_theme_resources.py theme_common/resources theme_override/resources dist/_theme
+python theme_common/scripts/combine_mkdocs_config_yaml.py theme_common/mkdocs.yml theme_override/mkdocs.yml mkdocs.yml

theme_override/mkdocs.yml

@@ -0,0 +1,22 @@
+site_name: Stakater Secrets Management
+docs_dir: content
+site_url: https://docs.stakater.com/secrets/
+repo_url: https://github.com/stakater/secrets-docs
+edit_uri: blob/main/content/
+use_directory_urls: false
+theme:
+  logo: assets/images/favicon.svg
+  favicon: assets/images/favicon.svg
+nav:
+  - Secrets Management:
+      - index.md
+      - introduction.md
+      - sealed-secrets.md
+      - vault.md
+      - Secrets Management as a Service:
+          - managed-service/offer.md
+          - managed-service/cluster_config.md
+      - External Secret Operator:
+          - external-secret-operator/introduction.md
+          - external-secret-operator/getting-started.md
+          - external-secret-operator/workflow.md