add submodules

Author: eksrha

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "docs/repos/helm-charts"]
+	path = docs/repos/helm-charts
+	url = git@github.com:fullstack-devops/helm-charts.git
+[submodule "docs/repos/github-actions-runner"]
+	path = docs/repos/github-actions-runner
+	url = git@github.com:fullstack-devops/github-actions-runner.git

README.md

@@ -1,24 +1,27 @@
-# Docs for fullstack-devops.github.io
+[![Publish docs via GitHub Pages](https://github.com/fullstack-devops/fullstack-devops.github.io/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/fullstack-devops/fullstack-devops.github.io/actions/workflows/gh-pages.yml)
 
-s
-## Run local
+# Docs for fullstack-devops
 
-### Installation
+Documentation about everything in this organization.
 
-install `mkdocs` if not aready done
+## Dev
 
-```bash
-pip install mkdocs
-```
+### Installation
 
-install all required plugins
+install `mkdocs-material` and requirements, if not aready done
 
 ```bash
-python3 setup.py
+pip install -r requirements.txt
 ```
 
 run and watch deployment
 
 ```bash
 mkdocs serve
 ```
+
+### Git Submodules
+
+How to add: `git submodule add <repo_clone_url>`
+
+How to get an update: `git pull --recurse-submodules`

docs/_static/custom.css

@@ -0,0 +1,2 @@
+# Repositories
+

docs/repos/github-actions-runner

@@ -0,0 +1,3 @@
+.md-grid {
+  max-width: 75rem;
+}

docs/repos/helm-charts

@@ -1,14 +1,14 @@
 # Project information
-site_name: Docs for fullstack-devops
-site_url: https://fullstack-devops.github.io/
+site_name: Docs for Fullstack and DevOps
+site_url: ""
 site_author: The fullstack-devops project
 site_description: >-
   Documentation for the fullstack-devops community and side projects
 
 # Repository
 repo_name: fullstack-devops/fullstack-devops.github.io
 repo_url: https://github.com/fullstack-devops/fullstack-devops.github.io
-edit_uri: ""
+edit_uri: "edit/main/docs"
 
 # Configuration
 theme:
@@ -28,7 +28,7 @@ theme:
     # - content.tabs.link
     - content.tooltips
     # - header.autohide
-    # - navigation.expand
+    - navigation.expand
     - navigation.indexes
     # - navigation.instant
     # - navigation.prune
@@ -60,20 +60,18 @@ theme:
     code: Roboto Mono
   favicon: https://avatars.githubusercontent.com/u/97617148?s=200&v=4
   logo: https://avatars.githubusercontent.com/u/97617148?s=200&v=4
+extra_css:
+  - stylesheets/custom.css
 
 docs_dir: ./docs
 
-extra_css:
-  - _static/custom.css
-
 # Plugins
 plugins:
   - search
   - minify:
       minify_html: true
-  - redirects:
-      redirect_maps:
-        helm-charts/getting-started.md: helm-charts/introduction.md
+  - git-revision-date-localized:
+      enable_creation_date: true
 
 # Customization
 extra:
@@ -112,11 +110,10 @@ markdown_extensions:
       repo: mkdocs-material
   - pymdownx.mark
   - pymdownx.smartsymbols
-  - pymdownx.superfences:
-      custom_fences:
-        - name: mermaid
-          class: mermaid
-          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.snippets:
+      # Fails the build if any imports are missing
+      check_paths: true
+  - pymdownx.superfences
   - pymdownx.tabbed:
       alternate_style: true
   - pymdownx.tasklist:
@@ -126,35 +123,11 @@ markdown_extensions:
 # Page tree
 nav:
   - Home: index.md
-  # - Helm Charts:
-  #     - Introduction: helm-charts/introduction.md
-  #     - Common: helm-charts/common-library.md
-  #     - Common Storage: helm-charts/common-library-storage.md
-  #     - Common Add-ons: helm-charts/common-library-add-ons.md
-  #     - Development:
-  #         - Creating a new chart: helm-charts/development/creating-a-new-chart.md
-  #         - Databases: our-helm-charts/development/databases.md
-  #         - Unit tests: our-helm-charts/development/unit-tests.md
-  # - Our Container Images:
-  #     - Introduction: our-container-images/introduction.md
-  #     - Configuration: our-container-images/configuration.md
-  #     - Permissions: our-container-images/permissions.md
-  #     - Development:
-  #         - Creating a new container image: >-
-  #             our-container-images/development/creating-a-new-container-image.md
-  #         - Dockerfile: our-container-images/development/dockerfile.md
-  #         - Base images: our-container-images/development/base-images.md
-  #         - Build: our-container-images/development/build.md
-  # - Our Code Projects:
-  #     - Introduction: our-own-code-projects/introduction.md
-  #     - Development:
-  #         - Creating a new project: >-
-  #             our-own-code-projects/development/creating-a-new-container-image.md
-  # - Guides:
-  #     - DynDNS with a CronJob: guides/dyndns.md
-  #     - Routing traffic through a VPN pod: guides/pod-gateway.md
-  #     - Updating Sonarr/Radarr with Recyclarr: guides/recyclarr.md
-  # - Support:
-  #     - Community: support/community.md
-  #     - FAQ: support/faq.md
-  #     - Code of Conduct: support/code-of-conduct.md
+  - Repositories:
+      - repos/index.md
+      - helm charts:
+          - repos/helm-charts/README.md
+          - excalidraw: repos/helm-charts/charts/excalidraw/README.md
+          - github-actions-runner: repos/helm-charts/charts/github-actions-runner/README.md
+      - github actions runner:
+        - repos/github-actions-runner/README.md

docs/repos/index.md

@@ -1,5 +1,7 @@
 mkdocs==1.3.1
-mkdocs-macros-plugin ==0.7.0
-mkdocs-material ==8.4.0
+mkdocs-macros-plugin==0.7.0
+mkdocs-material==8.4.0
 mkdocs-minify-plugin==0.5.0
-mkdocs-redirects==1.0.5
+mkdocs-redirects==1.0.5
+mkdocs-git-revision-date-localized-plugin==1.1.0
+mkdocs-snippet-plugin==1.0.2