Skip to content

Commit

Permalink
Switched structurizr.com/help/* links.
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbrowndotje committed Dec 15, 2023
1 parent 8509a03 commit a18e942
Show file tree
Hide file tree
Showing 26 changed files with 130 additions and 87 deletions.
6 changes: 3 additions & 3 deletions cloud/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ This will create a new empty workspace, which will be used to store your softwar

You now have a choice of how you would like to create the software architecture model in your workspace:

1. Pushing a Structurizr DSL file via the [workspace API](https://structurizr.com/help/web-api) using the [Structurizr CLI push command](/cli/push) (recommended).
2. Pushing a workspace created using one of the code-based client libraries (e.g. [Structurizr for Java](https://github.com/structurizr/java)) via the [workspace API](https://structurizr.com/help/web-api).
3. Using the browser-based DSL editor (not recommended - [it doesn't support the full feature set](https://structurizr.com/help/dsl#comparison)).
1. Pushing a Structurizr DSL file via the [workspace API](/cloud/workspace-api) using the [Structurizr CLI push command](/cli/push) (recommended).
2. Pushing a workspace created using one of the code-based client libraries (e.g. [Structurizr for Java](https://github.com/structurizr/java)) via the [workspace API](/cloud/workspace-api).
3. Using the browser-based DSL editor (not recommended - [it doesn't support the full feature set](/dsl#comparison)).

Although not the recommended approach, to get started quickly, click the "DSL editor" link on your workspace summary page - this provides a way to define your workspace using the
[Structurizr DSL](/dsl).
4 changes: 2 additions & 2 deletions dsl/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ permalink: /dsl/basics
- Closing curly brace symbols (`}`) must be on a line of their own.
- Opening/closing braces are only required when adding child content.
- Use `""` as a placeholder for an earlier optional property that you'd like to skip.
- Tags are comma separated (e.g. `Tag 1,Tag 2,Tag 3`) - see [Structurizr - Notation](https://structurizr.com/help/notation) for details of how tags and styling works.
- Tags are comma separated (e.g. `Tag 1,Tag 2,Tag 3`) - see [Structurizr - Notation](/ui/diagrams/notation) for details of how tags and styling works.

## Workspace rules

In addition, workspaces are subject to the following rules:

- Each view must have a unique "key" (this is generated for you if not specified; __automatically generated view keys are not guaranteed to be stable over time, and you will likely lose [manual layout information](https://structurizr.com/help/manual-layout) when using them in conjunction with Structurizr Lite/on-premises/cloud__).
- Each view must have a unique "key" (this is generated for you if not specified; __automatically generated view keys are not guaranteed to be stable over time, and you will likely lose [manual layout information](/ui/diagrams/manual-layout) when using them in conjunction with Structurizr Lite/on-premises/cloud__).
- Software and people names must be unique.
- Container names must be unique within the context of a software system.
- Component names must be unique within the context of a container.
Expand Down
2 changes: 1 addition & 1 deletion dsl/cookbook/filtered-view/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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:
A [filtered view](/ui/diagrams/filtered-view) 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:

```
workspace {
Expand Down
4 changes: 2 additions & 2 deletions dsl/cookbook/groups/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ workspace {
## Styling all groups

By default, groups are shown as dashed boundaries with a light grey colour.
This can be customised via an element style, as described at [Structurizr - Notation](https://structurizr.com/help/notation).
This can be customised via an element style, as described at [Structurizr - Notation](/ui/diagrams/notation).

To change the style for all groups, add an element style for the `Group` tag.

Expand Down Expand Up @@ -173,4 +173,4 @@ workspace {
Please note that element styles are designed to work with the Structurizr cloud service/on-premises installation/Lite, and may not be fully supported by the PlantUML, Mermaid, etc export formats.
Only the `color` and `icon` properties can be customised for groups.

- [Structurizr - Notation](https://structurizr.com/help/notation)
- [Structurizr - Notation](/ui/diagrams/notation)
4 changes: 2 additions & 2 deletions dsl/cookbook/image-view/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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.
An [image view](/ui/diagrams/image-view) represents an image that has been rendered outside of Structurizr, for inclusion in a Structurizr workspace.
Image views can be created from an arbitrary PNG/SVG file, or a PlantUML/Mermaid/Kroki diagram.
An example use case for an image view is to provide a "level 4" zoom-in for a component on a component diagram.

Expand Down Expand Up @@ -49,5 +49,5 @@ 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)
- [Image views](/ui/diagrams/image-view)
- [DSL language reference - image](/dsl/language#image-view)
2 changes: 1 addition & 1 deletion dsl/cookbook/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ permalink: /dsl/cookbook/

This cookbook is a tutorial guide to the Structurizr DSL, an open source tool for creating diagrams as code from
a single consistent model. This cookbook assumes that you're using the diagram renderer provided by the
[Structurizr cloud service](https://structurizr.com/help/cloud-service),
[Structurizr cloud service](/cloud),
the [Structurizr on-premises installation](/onpremises),
or [Structurizr Lite](/lite).

Expand Down
2 changes: 1 addition & 1 deletion dsl/cookbook/perspectives/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ workspace {
}
```

This DSL defines an "Ownership" perspective for each software system, which can be viewed by following the instructions at [Structurizr - Help - Perspectives](https://structurizr.com/help/perspectives).
This DSL defines an "Ownership" perspective for each software system, which can be viewed by following the instructions at [Perspectives](/ui/diagrams/perspectives).

[![](example-1.png)](http://structurizr.com/dsl?src=https://docs.structurizr.com/dsl/cookbook/perspectives/example-1.dsl&perspective=Ownership)

Expand Down
2 changes: 1 addition & 1 deletion dsl/cookbook/themes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ permalink: /dsl/cookbook/themes/

# Themes

Some pre-built themes are available to help you diagram deployment architectures that make use of popular cloud providers such as Amazon Web Services, Microsoft Azure, Google Cloud Platform, etc. Links to these themes can be found at [Structurizr - Help - Themes](https://structurizr.com/help/themes). You can also create your own themes.
Some pre-built themes are available to help you diagram deployment architectures that make use of popular cloud providers such as Amazon Web Services, Microsoft Azure, Google Cloud Platform, etc. Links to these themes can be found at [Themes](/ui/diagrams/themes). You can also create your own themes.

## What is a theme?

Expand Down
2 changes: 1 addition & 1 deletion dsl/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ By default, the [com.structurizr.importer.documentation.DefaultDocumentationImpo

- All Markdown and AsciiDoc files in the given directory will be imported, alphabetically according to the filename.
- All images in the given directory (and sub-directories) are also imported into the workspace.
- See [Structurizr - Documentation - Headings and sections](https://structurizr.com/help/documentation/headings) for details about how section headings and numbering are handled.
- See [Structurizr - Documentation - Headings and sections](/ui/documentation/headings) for details about how section headings and numbering are handled.

The above behaviour can be customised by specifying the fully qualified class name of your own implementation of [DocumentationImporter](https://github.com/structurizr/documentation/blob/main/src/main/java/com/structurizr/importer/documentation/DocumentationImporter.java), which needs to be on the DSL classpath or installed as a JAR file in the `plugins` directory next to your DSL file.

2 changes: 2 additions & 0 deletions dsl/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ There are a number of options for authoring workspaces with the Structurizr DSL.
| [Structurizr CLI](/cli) | The Structurizr CLI is a command line utility, designed to be used in conjunction with the Structurizr DSL. It provides the ability to push/pull workspaces to/from the Structurizr cloud service or an on-premises installation, in additional to exporting the views defined in a DSL file to other formats (PlantUML, Mermaid, WebSequenceDiagrams, and Ilograph). | Yes |
| Browser-based DSL editor | If you'd rather not use Structurizr Lite or the Structurizr CLI, the Structurizr cloud service/on-premises installation provides a basic online DSL editor. The editor provides some rudimentary syntax highlighting and the ability to use the DSL without installing any tooling, but it does not provide access to the full feature set of the DSL - see the comparison table below. The DSL editor can be opened using the link on your workspace summary page. | No |

## Comparison

Here is a comparison of the various authoring tools.

| Feature | DSL keyword | Structurizr Lite | Structurizr CLI | Browser-based DSL editor |
Expand Down
Loading

0 comments on commit a18e942

Please sign in to comment.