From 888574b35627135baec92b471675da46f0228918 Mon Sep 17 00:00:00 2001 From: Joris Kraak Date: Tue, 12 Mar 2024 14:50:05 +0100 Subject: [PATCH] docs(structurizr): specify view keys explicitly When view keys are not explicitly defined, Structurizr dynamically generates them. These keys may not be stable[^1] and may change across Structurizr versions, resulting in errors[^2]. [^1]: https://docs.structurizr.com/dsl/language#views [^2]: https://github.com/bauglir/Kroki.jl/actions/runs/8038492294/job/22264844603#step:5:10 --- docs/architecture/workspace.dsl | 6 +++--- docs/src/examples.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/architecture/workspace.dsl b/docs/architecture/workspace.dsl index 0bacbfc..6af0b64 100644 --- a/docs/architecture/workspace.dsl +++ b/docs/architecture/workspace.dsl @@ -76,17 +76,17 @@ workspace { } views { - container kroki_jl { + container kroki_jl PackageContainers { include * autoLayout lr } - component library { + component library PackageComponents { include * autoLayout bt } - container kroki_service { + container kroki_service ServiceContainers { include * autoLayout tb } diff --git a/docs/src/examples.md b/docs/src/examples.md index 0ab234e..aa199c0 100644 --- a/docs/src/examples.md +++ b/docs/src/examples.md @@ -182,7 +182,7 @@ rendered from the set defined in the file. structurizr_diagram = Diagram( :structurizr; path = joinpath(@__DIR__, "..", "architecture", "workspace.dsl"), - options = Dict("view-key" => "KrokiService-Container") + options = Dict("view-key" => "ServiceContainers") ) ``` @@ -218,7 +218,7 @@ end DocumenterSvg( render( structurizr_diagram, "svg"; - options = Dict("view-key" => "Krokijl-Krokijl-Component") + options = Dict("view-key" => "PackageComponents") ) ) ```