Merge pull request #141 from stakater/theme-and-reloader

Add common theme and Reloader link

.github/workflows/pull_request.yaml

@@ -7,13 +7,13 @@ on:
 
 jobs:
   qa:
-    uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.62
+    uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.73
     with:
       MD_CONFIG: .github/md_config.json
-      DOC_SRC: docs/content
+      DOC_SRC: docs
       MD_LINT_CONFIG: .markdownlint.yaml
   build:
-    uses: stakater/.github/.github/workflows/pull_request_container_build.yaml@v0.0.62
+    uses: stakater/.github/.github/workflows/pull_request_container_build.yaml@v0.0.73
     with:
       DOCKER_FILE_PATH: Dockerfile
     secrets:

.github/workflows/push.yaml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   push:
-    uses: stakater/.github/.github/workflows/push_container.yaml@v0.0.62
+    uses: stakater/.github/.github/workflows/push_container.yaml@v0.0.73
     with:
       DOCKER_FILE_PATH: Dockerfile
       RELEASE_BRANCH: main

.github/workflows/release.yaml

@@ -7,6 +7,6 @@ on:
 
 jobs:
   release:
-    uses: stakater/.github/.github/workflows/release_template.yaml@v0.0.62
+    uses: stakater/.github/.github/workflows/release_template.yaml@v0.0.73
     secrets:
       SLACK_WEBHOOK_URL: ${{ secrets.STAKATER_DELIVERY_SLACK_WEBHOOK }}

.gitignore

@@ -19,4 +19,6 @@ coverage/
 node_modules
 
 # Build files
+styles/
 site/
+/mkdocs.yml

.gitmodules

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

.markdownlint.yaml

@@ -2,5 +2,7 @@
   "MD007": { "indent": 4 },
   "MD013": false,
   "MD024": false,
+  "MD033": false,
+  "MD041": false,
   "MD046": false,
 }

.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.18/Stakater.zip
+Vocab = Stakater
 
 # Only check MarkDown files
 [*.md]

Dockerfile

@@ -1,19 +1,24 @@
 FROM python:3.12-alpine as builder
 
-RUN pip3 install mkdocs-material mkdocs-mermaid2-plugin
-
 # set workdir
 RUN mkdir -p $HOME/application
 WORKDIR $HOME/application
 
 # copy the entire application
 COPY --chown=1001:root . .
 
+RUN pip3 install -r theme_common/requirements.txt
+
+# Combine Theme Resources
+RUN python theme_common/scripts/combine_theme_resources.py theme_common/resources theme_override/resources dist/_theme
+# Produce mkdocs file
+RUN python theme_common/scripts/combine_mkdocs_config_yaml.py theme_common/mkdocs.yml theme_override/mkdocs.yml mkdocs.yml
+
 # build the docs
 RUN mkdocs build
 
 FROM nginxinc/nginx-unprivileged:1.26-alpine as deploy
-COPY --from=builder $HOME/application/site/ /usr/share/nginx/html/
+COPY --from=builder $HOME/application/site/ /usr/share/nginx/html/landing/
 COPY default.conf /etc/nginx/conf.d/
 
 # set non-root user

default.conf

@@ -6,22 +6,6 @@ server {
     location = /404.html {
         internal;
     }
-    location ~* ^/content/sre/multi-tenant-operator(/(.*))?$ {
-        return 301 $scheme://docs.stakater.com/mto/$2;
-    }
-    location ~* ^/content/sre/tronador(/(.*))?$ {
-        return 301 $scheme://docs.stakater.com/tronador/$2;
-    }
-    location ~* ^/content/sre/secrets-management(/(.*))?$ {
-        return 301 $scheme://docs.stakater.com/secrets/$2;
-    }
-    location ~* ^/content/openshift-as-a-service(/(.*))?$ {
-        return 301 $scheme://docs.stakater.com/oaas/$2;
-    }
-    location = /content/sre/support/support.html {
-        return 301 $scheme://docs.stakater.com/saap/help/support/support.html;
-    }
-    location ~* ^/content(/.*)?$ {
-        return 301 $scheme://docs.stakater.com/saap/;
-    }
+    # redirects issued by nginx will be relative
+    absolute_redirect off;
 }

docs/index.md

@@ -1,3 +1,9 @@
+---
+hide:
+  - navigation
+  - toc
+---
+
 <p style="border:1px; border-style:ridge; border-color:#000000; padding: 0em;"></p>
 
 <h1 style="text-align: center;">Stakater Cloud Documentation</h1>
@@ -10,4 +16,6 @@
 
 [Multi Tenant Operator (MTO)](https://docs.stakater.com/mto/){ .md-button }
 
+[Reloader](https://docs.stakater.com/reloader/){ .md-button }
+
 [Tronador](https://docs.stakater.com/tronador/){ .md-button }

renovate.json

@@ -1,6 +1,21 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
-    "config:base"
+    "config:recommended"
+  ],
+  "labels": [
+    "dependencies"
+  ],
+  "customManagers": [
+    {
+        "customType": "regex",
+        "fileMatch": [
+            ".vale.ini"
+        ],
+        "matchStrings": [
+            "https:\/\/github\\.com\/(?<depName>.*)\/releases\/download\/(?<currentValue>.*)\/.*\\.zip"
+        ],
+        "datasourceTemplate": "github-releases"
+    }
   ]
 }

theme_override/mkdocs.yml

@@ -0,0 +1,11 @@
+site_name: Stakater Cloud Documentation
+docs_dir: docs
+site_url: https://docs.stakater.com/
+repo_url: https://github.com/stakater/StakaterCloudDocs
+edit_uri: blob/main/docs/
+
+markdown_extensions:
+  - attr_list
+
+nav:
+  - index.md