[Task] Update support docs with submodule mkdocs SA 5307 (#19)

* Updated support docs with git submodule mkdocs

* Updated vocabulary to vale instead of submodule

* Removed vocabulary

* Updated content path

* Updated git ignore file to remove the root mkdocs yml file

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

* Fixed the indentation for pull request

* Removed footer logo from override

* Modified support docs override

.github/workflows/pull_request.yaml

@@ -3,21 +3,21 @@ name: Pull Request
 on:
   pull_request:
     branches:
-      - 'main'
+      - "main"
 
 jobs:
   qa:
-    uses: stakater/.github/.github/workflows/[email protected].62
+    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].62
+    uses: stakater/.github/.github/workflows/[email protected].75
     with:
       DOCKER_FILE_PATH: Dockerfile
     secrets:
       CONTAINER_REGISTRY_URL: ghcr.io/stakater
       CONTAINER_REGISTRY_USERNAME: stakater-user
       CONTAINER_REGISTRY_PASSWORD: ${{ secrets.STAKATER_GITHUB_TOKEN }}
-      SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }} 
+      SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }}

.github/workflows/push.yaml

@@ -3,17 +3,17 @@ name: Push
 on:
   push:
     branches:
-      - 'main'
+      - "main"
 
 jobs:
   push:
-    uses: stakater/.github/.github/workflows/[email protected].62
+    uses: stakater/.github/.github/workflows/[email protected].75
     with:
       DOCKER_FILE_PATH: Dockerfile
       RELEASE_BRANCH: main
     secrets:
       CONTAINER_REGISTRY_URL: ghcr.io/stakater
       CONTAINER_REGISTRY_USERNAME: stakater-user
       CONTAINER_REGISTRY_PASSWORD: ${{ secrets.STAKATER_GITHUB_TOKEN }}
-      SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }} 
+      SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }}
       GH_TOKEN: ${{ secrets.STAKATER_GITHUB_TOKEN }}

.github/workflows/release.yaml

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

.gitignore

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

.gitmodules

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

.vale.ini

@@ -1,7 +1,8 @@
-StylesPath = "vocabulary/styles"
+StylesPath = styles
 MinAlertLevel = warning
 
-Vocab = "Stakater"
+Packages = https://github.com/stakater/vale-package/releases/download/v0.0.17/Stakater.zip
+Vocab = Stakater
 
 # Only check MarkDown files
 [*.md]

Dockerfile

@@ -1,6 +1,6 @@
 FROM python:3.12 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

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,11 @@
+site_name: Stakater Support
+docs_dir: content
+site_url: https://support.stakater.com/
+repo_url: https://github.com/stakater/support-docs
+edit_uri: blob/main/content/
+use_directory_urls: false
+theme:
+  logo: assets/images/favicon.svg
+  favicon: assets/images/favicon.svg
+nav:
+  - index.md