Skip to content

Commit

Permalink
Adds a usage page.
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbrowndotje committed Dec 12, 2023
1 parent 4205284 commit 9ab1505
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 9 deletions.
23 changes: 23 additions & 0 deletions onpremises/03-usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
layout: default
title: Usage
parent: Structurizr on-premises
nav_order: 4
permalink: /onpremises/usage
---

# Usage

The on-premises installation is designed as a way to "publish" diagrams and documentation (a "workspace")
via a unique URL per workspace, for other people within your organisation to view. The general usage pattern is:

1. Create a workspace:
1. Using the UI (you'll see a "New workspace" link after signing in).
2. Using the [admin API](/onpremises/admin-api).
2. Author your workspace:
1. Pushing a Structurizr DSL file via the [workspace API](/onpremises/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](/onpremises/workspace-api).
3. Using the browser-based DSL editor (not recommended - [it doesn't support the full feature set](https://structurizr.com/help/dsl#comparison)).
3. View the diagrams and documentation via your web browser.

Please note that, unlike [Structurizr Lite](/lite/usage), you should not directly modify any `workspace.json` files in the data directory.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Configuration
parent: Structurizr on-premises
nav_order: 3
nav_order: 4
permalink: /onpremises/configuration
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Authentication
parent: Structurizr on-premises
nav_order: 4
nav_order: 5
permalink: /onpremises/authentication
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Authorisation
parent: Structurizr on-premises
nav_order: 5
nav_order: 6
permalink: /onpremises/authorisation
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: HTTP sessions
parent: Structurizr on-premises
nav_order: 6
nav_order: 7
permalink: /onpremises/http-sessions
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Data storage
parent: Structurizr on-premises
nav_order: 7
nav_order: 8
permalink: /onpremises/data-storage
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Workspace API
parent: Structurizr on-premises
nav_order: 8
nav_order: 9
permalink: /onpremises/workspace-api
---

Expand Down
2 changes: 1 addition & 1 deletion onpremises/09-admin-api.md → onpremises/10-admin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Admin API
parent: Structurizr on-premises
nav_order: 9
nav_order: 10
permalink: /onpremises/admin-api
---

Expand Down
2 changes: 1 addition & 1 deletion onpremises/10-faq.md → onpremises/11-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: FAQ
parent: Structurizr on-premises
nav_order: 10
nav_order: 11
permalink: /onpremises/faq
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Troubleshooting
parent: Structurizr on-premises
nav_order: 11
nav_order: 12
permalink: /onpremises/troubleshooting
---

Expand Down

0 comments on commit 9ab1505

Please sign in to comment.