From 31fd922df51e37d3d48ae8cafdfa10994e480a93 Mon Sep 17 00:00:00 2001 From: Mike Kell Date: Mon, 30 Mar 2026 08:16:38 -0400 Subject: [PATCH] Added PlantUML SVG inages to workflow and system landscape page --- .forgejo/workflows/publish-docs.yml | 13 ++++++++++++- .forgejo/workflows/validate-docs.yml | 11 +++++++++++ docs/architecture/system-landscape.md | 6 ++---- 3 files changed, 25 insertions(+), 5 deletions(-) diff --git a/.forgejo/workflows/publish-docs.yml b/.forgejo/workflows/publish-docs.yml index e08d796..a9c34b9 100644 --- a/.forgejo/workflows/publish-docs.yml +++ b/.forgejo/workflows/publish-docs.yml @@ -13,6 +13,17 @@ jobs: - name: Checkout uses: actions/checkout@v4 + - name: Render PlantUML diagrams to SVG + run: | + mkdir -p docs/images + rm -f architecture/workspace/*.svg + docker run --rm \ + -v "$PWD:/work" \ + -w /work \ + ghcr.io/plantuml/plantuml \ + -tsvg architecture/workspace/*.puml + cp architecture/workspace/*.svg docs/images/ + - name: Build MkDocs site run: | docker run --rm \ @@ -22,4 +33,4 @@ jobs: - name: Publish site to docs host run: | - rsync -rlDz --delete site/ /opt/kellcreations/docs-platform/published/site/ \ No newline at end of file + rsync -rlDz --delete site/ /opt/kellcreations/docs-platform/published/site/ \ No newline at end of file diff --git a/.forgejo/workflows/validate-docs.yml b/.forgejo/workflows/validate-docs.yml index 90ba9fa..a072019 100644 --- a/.forgejo/workflows/validate-docs.yml +++ b/.forgejo/workflows/validate-docs.yml @@ -14,6 +14,17 @@ jobs: - name: Checkout uses: actions/checkout@v4 + - name: Render PlantUML diagrams to SVG + run: | + mkdir -p docs/images + rm -f architecture/workspace/*.svg + docker run --rm \ + -v "$PWD:/work" \ + -w /work \ + ghcr.io/plantuml/plantuml \ + -tsvg architecture/workspace/*.puml + cp architecture/workspace/*.svg docs/images/ + - name: Build MkDocs site run: | docker run --rm \ diff --git a/docs/architecture/system-landscape.md b/docs/architecture/system-landscape.md index 859aba8..90947e2 100644 --- a/docs/architecture/system-landscape.md +++ b/docs/architecture/system-landscape.md @@ -8,11 +8,9 @@ It identifies the primary business users, the central Kell Creations platform, a This view is intended to provide a management-level understanding of the platform ecosystem. It is the starting point for more detailed context, container, component, deployment, and workflow diagrams. -## Diagram Source +## Diagram -The source for this diagram is maintained as architecture code in: - -`architecture/workspace/system-landscape.puml` +![System Landscape](../images/system-landscape.svg) ## Included Systems