Skip to content

Commit 737e964

Browse files
Adds a recommended workflow page.
1 parent 7fd6eb8 commit 737e964

File tree

6 files changed

+23
-6
lines changed

6 files changed

+23
-6
lines changed

usage/authoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Authoring
4-
parent: Usage
4+
parent: Usage and Workflow
55
nav_order: 2
66
permalink: /usage/authoring
77
---

usage/enterprise.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Enterprise
4-
parent: Usage
4+
parent: Usage and Workflow
55
nav_order: 4
66
permalink: /usage/enterprise
77
---

usage/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
22
layout: default
3-
title: Usage
3+
title: Usage and Workflow
44
nav_order: 6
55
has_children: true
66
permalink: /usage
77
has_toc: false
88
---
99

10-
# Usage
10+
# Usage and Workflow
1111

1212
Given the variety of [products](/products) and [community tooling](/community), there are many ways in which the
1313
Structurizr tooling can be used. This section will look at usage from a few different angles:
1414

15+
- [Recommended workflow](/usage/workflow)
1516
- [Workspace authoring](/usage/authoring)
1617
- [Workspace rendering](/usage/rendering)
1718
- [Team usage](/usage/team)

usage/rendering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Rendering
4-
parent: Usage
4+
parent: Usage and Workflow
55
nav_order: 3
66
permalink: /usage/rendering
77
---

usage/team.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Team
4-
parent: Usage
4+
parent: Usage and Workflow
55
nav_order: 3
66
permalink: /usage/team
77
---

usage/workflow.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
layout: default
3+
title: Recommended workflow
4+
parent: Usage and Workflow
5+
nav_order: 1
6+
permalink: /usage/workflow
7+
---
8+
9+
# Recommended workflow
10+
11+
There are many ways in which the Structurizr tooling can be used,
12+
but the simplest and recommended workflow is as follows:
13+
14+
1. Author workspaces locally using a combination of the [Structurizr DSL](/dsl), [Structurizr Lite](/lite) ([quickstart](/lite/quickstart)), and one of the [VS Code/IDE extensions](/community#structurizr-dsl-editor-and-ide-plugins).
15+
2. Store DSL files in version control (e.g. git).
16+
3. Publish workspaces to an [on-premises installation](/onpremises) or the [cloud service](/cloud) via the [Structurizr CLI](/cli) if the diagrams/documentation need to be viewed by a wider audience. This can be done manually or via a CI/CD build pipeline.

0 commit comments

Comments
 (0)