Skip to content

Commit

Permalink
docs(structurizr): specify view keys explicitly
Browse files Browse the repository at this point in the history
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
  • Loading branch information
bauglir committed Mar 12, 2024
1 parent 0f0566a commit 888574b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/architecture/workspace.dsl
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Expand Down
4 changes: 2 additions & 2 deletions docs/src/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")
)
```

Expand Down Expand Up @@ -218,7 +218,7 @@ end
DocumenterSvg(
render(
structurizr_diagram, "svg";
options = Dict("view-key" => "Krokijl-Krokijl-Component")
options = Dict("view-key" => "PackageComponents")
)
)
```
Expand Down

0 comments on commit 888574b

Please sign in to comment.