Skip to content

Commit

Permalink
Fix links, add cookbook front matter.
Browse files Browse the repository at this point in the history
  • Loading branch information
Simon Brown committed Sep 1, 2023
1 parent eaa62ee commit ed416f0
Show file tree
Hide file tree
Showing 12 changed files with 86 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Container view (spanning multiple software systems)
---
layout: default
title: Container view (for multiple software systems)
parent: Cookbook
grand_parent: Structurizr DSL
permalink: /dsl/cookbook/container-view-multiple-software-systems
---

# Container view (for multiple software systems)

By default, the `include *` statement, when used inside a container view definition, will include all of the containers
inside the software system in scope, along with any external software system dependencies.
Expand Down
8 changes: 8 additions & 0 deletions dsl/cookbook/deployment-groups/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Deployment groups
parent: Cookbook
grand_parent: Structurizr DSL
permalink: /dsl/cookbook/deployment-groups
---

# Deployment groups

Imagine that you have a service comprised of an API and a database scheme, which are deployed together onto a single server.
Expand Down
8 changes: 8 additions & 0 deletions dsl/cookbook/dsl-and-code/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: DSL and code
parent: Cookbook
grand_parent: Structurizr DSL
permalink: /dsl/cookbook/dsl-and-code
---

# DSL and code

It's possible to use both the DSL and a code-based library together - perhaps you want to define a basic model via the DSL, and use automatic extraction to add components to the model. To do this, define your workspace using the DSL as normal, for example:
Expand Down
8 changes: 8 additions & 0 deletions dsl/cookbook/dynamic-view-parallel/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Dynamic view (with parallel sequences)
parent: Cookbook
grand_parent: Structurizr DSL
permalink: /dsl/cookbook/dynamic-view-parallel
---

# Dynamic view with parallel sequences

Dynamic views can also be used to show parallel sequences of interactions, to indicate some degree of concurrency.
Expand Down
8 changes: 8 additions & 0 deletions dsl/cookbook/dynamic-view/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Dynamic view
parent: Cookbook
grand_parent: Structurizr DSL
permalink: /dsl/cookbook/dynamic-view
---

# Dynamic view

A [dynamic view](https://c4model.com/#DynamicDiagram) allows you to show a subset of the elements in a model, and the relationships between them, in order to describe how a particular use case/story/feature works. Dynamic views show ordered __instances__ of relationships, therefore reducing the number of relationships you need to define in the static model - see [Modelling multiple relationships](https://dev.to/simonbrown/modelling-multiple-relationships-51bf) for more.
Expand Down
8 changes: 8 additions & 0 deletions dsl/cookbook/filtered-view/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Filtered view
parent: Cookbook
grand_parent: Structurizr DSL
permalink: /dsl/cookbook/filtered-view
---

# Filtered view

A [filtered view](https://structurizr.com/help/filtered-views) represents "a view on top of another view", which can be used to filter (`include` or `exclude`) specific elements and/or relationships, based upon their tag. Consider the following workspace definition:
Expand Down
10 changes: 9 additions & 1 deletion dsl/cookbook/groups/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
---
layout: default
title: Groups
parent: Cookbook
grand_parent: Structurizr DSL
permalink: /dsl/cookbook/groups
---

# Groups

The `group` keyword provides a way to define a named grouping of elements, which will be rendered as a boundary around those elements.
See [DSL language reference - group](../../language-reference.md#group) for more details.
See [DSL language reference - group](/dsl/language.md#group) for more details.

## Example

Expand Down
10 changes: 9 additions & 1 deletion dsl/cookbook/image-view/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Image view
parent: Cookbook
grand_parent: Structurizr DSL
permalink: /dsl/cookbook/image-view
---

# Image view

An [image view](https://structurizr.com/help/image-views) represents an image that has been rendered outside of Structurizr, for inclusion in a Structurizr workspace.
Expand Down Expand Up @@ -42,4 +50,4 @@ This DSL defines an image view for the "Component 1" component, based upon a Mer
## Links

- [Structurizr - Help - Image views](https://structurizr.com/help/image-views)
- [DSL language reference - image view](/dsl/language#image-view)
- [DSL language reference - image](/dsl/language#image-view)
8 changes: 8 additions & 0 deletions dsl/cookbook/implied-relationships/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Implied relationships
parent: Cookbook
grand_parent: Structurizr DSL
permalink: /dsl/cookbook/implied-relationships
---

# Implied relationships

By default, the Structurizr DSL will create "implied relationships" automatically. For example, consider the following DSL, which defines a relationship between a person and a container.
Expand Down
8 changes: 8 additions & 0 deletions dsl/cookbook/perspectives/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
layout: default
title: Perspectives
parent: Cookbook
grand_parent: Structurizr DSL
permalink: /dsl/cookbook/perspectives
---

# Perspectives

Structurizr supports the concept of "perspectives" from [viewpoints and perspectives](https://www.viewpoints-and-perspectives.info/home/perspectives/), where you want to look at a diagram with a view to answering a particular question.
Expand Down
2 changes: 1 addition & 1 deletion dsl/cookbook/system-context-view/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ System context views can be rendered using the Structurizr cloud service/on-prem

## Links

- [DSL language reference - systemContext](/dsl/language#systemContext-view)
- [DSL language reference - systemContext](/dsl/language#systemcontext-view)
4 changes: 2 additions & 2 deletions dsl/language.md
Original file line number Diff line number Diff line change
Expand Up @@ -548,8 +548,8 @@ views {

The `views` block can contain the following:

- [systemLandscape](#systemLandscape-view)
- [systemContext](#systemContext-view)
- [systemLandscape](#systemlandscape-view)
- [systemContext](#systemcontext-view)
- [container](#container-view)
- [component](#component-view)
- [filtered](#filtered-view)
Expand Down

0 comments on commit ed416f0

Please sign in to comment.