Skip to content

Commit

Permalink
Doc updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
@simonbrowndotje
simonbrowndotje committed Sep 9, 2024
1 parent 33b6f2e commit 392f40c
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 31 deletions.
4 changes: 2 additions & 2 deletions cloud/workspace-versioning.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ changes to your diagrams.

## Viewing a previous version

To view a previous version, open the workspace summary page for your workspace, select a version from the dropdown list,
and click the "Load version" button. A label will be displayed when viewing content from a previous version of a workspace,
To view a previous version, open the workspace summary page for your workspace, select a version from the dropdown list.
A label will be displayed when viewing content from a previous version of a workspace,
to signify that you are not looking at the latest version.

## Reverting to a previous version
Expand Down
7 changes: 4 additions & 3 deletions onpremises/09-workspace-versioning.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ changes to your diagrams.

## Viewing a previous version

To view a previous version, open the workspace summary page for your workspace, select a version from the dropdown list,
and click the "Load version" button. A label will be displayed when viewing content from a previous version of a workspace,
To view a previous version, open the workspace summary page for your workspace, select a version from the dropdown list.
A label will be displayed when viewing content from a previous version of a workspace,
to signify that you are not looking at the latest version.

## Reverting to a previous version
Expand All @@ -27,4 +27,5 @@ cause that version to be the latest version once again.
## Notes

- The number of retained versions can be [configured](/onpremises/configuration) via a property named `structurizr.maxWorkspaceVersions`.
- Diagram thumbnails are not stored for previous workspace versions.
- Diagram thumbnails are not stored for previous workspace versions.
- Previous versions are not included in the search index.
53 changes: 27 additions & 26 deletions products.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,29 +40,30 @@ workspace via the web API provided by the cloud service and on-premises installa

## Comparison

| Feature | Lite | On-premises | Cloud (free) | Cloud (paid) |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|--------------------------------------|-----------------------------|---------------------------------------|
| [Workspaces](/workspaces)<br />A workspace is the wrapper for your software architecture model, views and supplementary documentation. | 1 | 1+ | 1 | 5+ |
| [Workspace scope](/workspaces#validation)<br />Workspace scope and content validation (strict vs relaxed). | Strict or relaxed | Strict or relaxed | Strict only | Strict or relaxed |
| Sharing link<br />Share your workspace using a read-only URL. | | Yes | | [Yes](/cloud/workspace-visibility) |
| Role-based access<br />Share your workspace with team members, using role-based security. | | [Yes](/onpremises/role-based-access) | | [Yes](/cloud/role-based-access) |
| Restrict access by IP address<br />Configure allowed IP addresses for extra security. | | | | [Yes](/cloud/ip-address-restrictions) |
| Client-side encryption<br />Encrypt workspaces before uploading via the cloud API, and decrypt them in your browser using your own passphrase. | | Yes | | [Yes](/cloud/client-side-encryption) |
| Workspace locking<br />Workspace locking to avoid concurrent updates. | | Yes | | [Yes](/cloud/workspace-locking) |
| Workspace versioning<br />Recent versions of your workspace are retained. | | Yes | | [Yes](/cloud/workspace-versioning) |
| Full-text search<br />Search for diagrams and documentation across all workspaces. | Yes | Yes | | Yes |
| [Diagrams](/ui/diagrams)<br />C4 model diagrams (core and supplementary). | Yes | Yes | Yes (max 10) | Yes |
| Diagram reviews<br />A visual diagram review tool. | | [Yes](/onpremises/diagram-review) | | [Yes](/cloud/diagram-review) |
| [Documentation](/ui/documentation)<br />Lightweight supplementary documentation using Markdown or AsciiDoc to complement the software architecture diagrams. | Yes | Yes | Yes | Yes |
| [Decision log](/ui/decisions)<br />Supplement the architecture model with a log of the key decisions (e.g. architecture decision records). | Yes | Yes | Yes | Yes |
| [Explorations](/ui/explorations)<br />Alternative, automatic visualisations that can be used to explore the software architecture model. | Yes | Yes | Yes | Yes |
| [Health checks](/ui/diagrams/health-checks)<br />Supplement your deployment models with HTTP-based health checks to get an "at a glance" view of the health of your software systems. | Yes | Yes | Yes | Yes |
| [Diagram export](/ui/diagrams/export)<br />Export diagrams (and their key/legend) to PNG and SVG files. | Yes | Yes | Yes | Yes |
| [Documentation export](/ui/documentation/export)<br />Export documentation to a single HTML page. | Yes | Yes | Yes | Yes |
| Embed diagrams<br />Embed diagrams in web pages. | | [Yes](/onpremises/embed) | | [Yes](/cloud/embed) |
| Workspace API<br />Push/pull workspace content via a web API. | | [Yes](/onpremises/workspace-api) | [Yes](/cloud/workspace-api) | [Yes](/cloud/workspace-api) |
| Admin API<br />List/create workspaces a web API. | | [Yes](/onpremises/admin-api) | | [Yes](/cloud/admin-api) |
| Notion<br />Embed live architecture diagrams into Notion pages via an iframe. | | | | [Yes](/cloud/notion) |
| Slack<br />Perform a full-text search across a workspace using a slash command. | | | | [Yes](/cloud/slack) |
| Authentication via LDAP or SAML 2.0<br />Integrate Structurizr with your identity provider. | | [Yes](/onpremises/authentication) | | |
| [Priority support](https://structurizr.com/help/support)<br />Priority support (Monday to Friday; 9-5 UK time). | With paid support package | With paid support package | | Yes |
| Feature | Lite | On-premises | Cloud (free) | Cloud (paid) |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-----------------------------------------|-----------------------------|---------------------------------------|
| [Workspaces](/workspaces)<br />A workspace is the wrapper for your software architecture model, views and supplementary documentation. | 1 | 1+ | 1 | 5+ |
| [Workspace scope](/workspaces#validation)<br />Workspace scope and content validation (strict vs relaxed). | Strict or relaxed | Strict or relaxed | Strict only | Strict or relaxed |
| Sharing link<br />Share your workspace using a read-only URL. | | Yes | | [Yes](/cloud/workspace-visibility) |
| Role-based access<br />Share your workspace with team members, using role-based security. | | [Yes](/onpremises/role-based-access) | | [Yes](/cloud/role-based-access) |
| Restrict access by IP address<br />Configure allowed IP addresses for extra security. | | | | [Yes](/cloud/ip-address-restrictions) |
| Client-side encryption<br />Encrypt workspaces before uploading via the cloud API, and decrypt them in your browser using your own passphrase. | | Yes | | [Yes](/cloud/client-side-encryption) |
| Workspace locking<br />Workspace locking to avoid concurrent updates. | | Yes | | [Yes](/cloud/workspace-locking) |
| Workspace versioning<br />Recent versions of your workspace are retained. | | [Yes](/onpremises/workspace-versioning) | | [Yes](/cloud/workspace-versioning) |
| Workspace branches<br />Store parallel versions of your workspace. | | [Yes](/onpremises/workspace-branches) | | |
| Full-text search<br />Search for diagrams and documentation across all workspaces. | Yes | Yes | | Yes |
| [Diagrams](/ui/diagrams)<br />C4 model diagrams (core and supplementary). | Yes | Yes | Yes (max 10) | Yes |
| Diagram reviews<br />A visual diagram review tool. | | [Yes](/onpremises/diagram-review) | | [Yes](/cloud/diagram-review) |
| [Documentation](/ui/documentation)<br />Lightweight supplementary documentation using Markdown or AsciiDoc to complement the software architecture diagrams. | Yes | Yes | Yes | Yes |
| [Decision log](/ui/decisions)<br />Supplement the architecture model with a log of the key decisions (e.g. architecture decision records). | Yes | Yes | Yes | Yes |
| [Explorations](/ui/explorations)<br />Alternative, automatic visualisations that can be used to explore the software architecture model. | Yes | Yes | Yes | Yes |
| [Health checks](/ui/diagrams/health-checks)<br />Supplement your deployment models with HTTP-based health checks to get an "at a glance" view of the health of your software systems. | Yes | Yes | Yes | Yes |
| [Diagram export](/ui/diagrams/export)<br />Export diagrams (and their key/legend) to PNG and SVG files. | Yes | Yes | Yes | Yes |
| [Documentation export](/ui/documentation/export)<br />Export documentation to a single HTML page. | Yes | Yes | Yes | Yes |
| Embed diagrams<br />Embed diagrams in web pages. | | [Yes](/onpremises/embed) | | [Yes](/cloud/embed) |
| Workspace API<br />Push/pull workspace content via a web API. | | [Yes](/onpremises/workspace-api) | [Yes](/cloud/workspace-api) | [Yes](/cloud/workspace-api) |
| Admin API<br />List/create workspaces a web API. | | [Yes](/onpremises/admin-api) | | [Yes](/cloud/admin-api) |
| Notion<br />Embed live architecture diagrams into Notion pages via an iframe. | | | | [Yes](/cloud/notion) |
| Slack<br />Perform a full-text search across a workspace using a slash command. | | | | [Yes](/cloud/slack) |
| Authentication via LDAP or SAML 2.0<br />Integrate Structurizr with your identity provider. | | [Yes](/onpremises/authentication) | | |
| [Priority support](https://structurizr.com/help/support)<br />Priority support (Monday to Friday; 9-5 UK time). | With paid support package | With paid support package | | Yes |

0 comments on commit 392f40c

Please sign in to comment.