Merge pull request #225 from rackerlabs/workflow-diagrams-20240819

feat: Adds rendering of argo workflows as mkdocs mermaid diagrams

.github/workflows/mkdocs.yaml

@@ -38,6 +38,8 @@ jobs:
           cache: pip
           cache-dependency-path: requirements-docs.txt
       - run: pip install -r requirements-docs.txt
+      - run: rm -rf docs/workflows && mkdir docs/workflows
+      - run: python scripts/argo-workflows-to-mkdocs.py argo-workflows docs/workflows
       - run: mkdocs build --strict
       - uses: actions/upload-pages-artifact@v2
         with:

.gitignore

@@ -18,3 +18,7 @@ venv/
 /python/*/dist/
 __pycache__
 .coverage
+
+# auto-generated argo-workflows docs
+# see .github/workflows/mkdocs.yaaml
+docs/workflows/

mkdocs.yml

@@ -55,6 +55,18 @@ markdown_extensions:
   - attr_list
   - def_list
   - md_in_html
+  - pymdownx.caret
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.superfences:
+      custom_fences:
+        - name: python
+          class: python
+          validator: !!python/name:markdown_exec.validator
+          format: !!python/name:markdown_exec.formatter
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
   - pymdownx.emoji:
       emoji_index: !!python/name:material.extensions.emoji.twemoji
       emoji_generator: !!python/name:material.extensions.emoji.to_svg
@@ -63,6 +75,7 @@ markdown_extensions:
       line_spans: __span
       pygments_lang_class: true
   - pymdownx.inlinehilite
+  - pymdownx.mark
   - pymdownx.snippets
   - pymdownx.superfences
   - pymdownx.tabbed:
@@ -73,6 +86,9 @@ extra_css:
 
 plugins:
   - search
+  - include_dir_to_nav:
+      sort_file: true
+      sort_directory: true
 
 validation:
   omitted_files: warn
@@ -104,3 +120,4 @@ nav:
     - user-guide/openstack-cli.md
     - user-guide/openstack-image.md
     - user-guide/rabbitmq-cheat-sheet.md
+  - Workflows: workflows/

requirements-docs.txt

@@ -1,2 +1,7 @@
 mkdocs
 mkdocs-material
+mkdocs-swagger-ui-tag
+mkdocs-glightbox
+markdown-exec
+mkdocs-multirepo-plugin>=0.8.3
+mkdocs-include-dir-to-nav