Merge pull request #34 from stakater/task/use-mkdocs-git-submodule-in…

…-oaas-docs-sa-5305

[Task] Use mkdocs git submodule in oaas docs SA 5305

.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

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,33 @@
+site_name: OpenShift as a Service
+docs_dir: content
+site_url: https://docs.stakater.com/oaas/
+repo_url: https://github.com/stakater/oaas-docs
+edit_uri: blob/main/content/
+use_directory_urls: false
+
+theme:
+  logo: assets/images/favicon.svg
+  favicon: assets/images/favicon.svg
+  custom_dir: dist/_theme
+  features:
+    - content.code.copy
+    - content.code.select
+
+nav:
+  - OpenShift as a Service:
+      - index.md
+      - general-provisions.md
+      - service-composition.md
+      - business-hours.md
+      - technical-support.md
+      - updating-clusters.md
+      - Runbooks:
+          - upgrades.md
+      - sla.md
+      - cost.md
+  - Stakater Home: https://www.stakater.com/
+  - SAAP: https://www.stakater.com/saap-kubernetes-openshift
+  - Consultancy: https://www.stakater.com/kubernetes-consultancy
+  - Events: https://www.stakater.com/events
+  - Platform Assessment: https://www.stakater.com/kubernetes-platform-assessment
+  - Careers: https://www.stakater.com/careers