Skip to content

Commit 2b020e3

Browse files
kevinmaeskevinmaes
authored
Merge pull request #183 from statelyai/laurakalbag/sta-4844-document-locking
Lock docs (Document the machine locking Pro feature)
2 parents 01e6099 + 0dcfaee commit 2b020e3

File tree

9 files changed

+110
-6
lines changed

9 files changed

+110
-6
lines changed

‎docs/lock-machines.mdx

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Lock machines
3+
---
4+
5+
You can lock a machine anytime to prevent accidental edits. Locked machines have a <Lock size={18} /> **Locked** status displayed in the editor’s top bar.
6+
7+
Hover over the <Lock size={18} /> **Locked** text to view who locked the machine and when.
8+
9+
:::studio
10+
11+
Locking machines is a Pro feature of the Studio. [Check out the features on our Pro plan](/studio-pro-plan.mdx) or [upgrade to try the Pro plan with a 30-day free trial](https://stately.ai/registry/billing).
12+
13+
:::
14+
15+
Locking a machine prevents you, or anyone else on your team, from the following:
16+
17+
- Editing the machine
18+
- Deleting the machine
19+
- Renaming the machine
20+
- [Importing code](import-from-code.mdx) to replace the machine
21+
- [Restoring a past version](versions) of the machine
22+
23+
If somebody else is viewing or editing the machine when it is locked, their changes will not be saved, and they will be notified that the machine is now locked.
24+
25+
## How to lock and unlock a machine
26+
27+
From the editor menu, go to **Machine** > <Unlock size={18} /> **Lock machine** / <Lock size={18} /> **Unlock machine**.
28+
29+
From the machine’s <Info size={18} /> **Details** panel, use the <Unlock size={18} /> Lock machine / <Lock size={18} /> Unlock machine icon button.
30+
31+
## Team roles and locking machines
32+
33+
All team members can view locked machines. Only team owners, Admins, and Editors can lock and unlock machines.
34+
35+
| Capability | Owner | Admin | Editor | Viewer |
36+
| ----------------------- | ------ | ------ | ------ | ------ |
37+
| View locked machine | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
38+
| Lock and unlock machine | ✅ Yes | ✅ Yes | ✅ Yes | 🚫 No |

‎docs/studio-pro-plan.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ title: Stately Studio Pro plan
1313
- [Version history](/versions.mdx)
1414
- [Import from GitHub](/import-from-github.mdx)
1515
- [Live simulation mode](/live-simulation.mdx)
16+
- [Lock machines](/lock-machines.mdx)
1617
- [Color states and transitions](/colors.mdx)
1718
- [Priority support](/studio-pro-plan.mdx#priority-support)
1819
- GitHub Sync (coming soon!)

‎docs/teams.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,11 @@ The following table is an overview of the capabilities of each team role:
3131
| ---------------------------------------- | ------ | ------ | ------ | ------ |
3232
| View team projects and machines | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
3333
| View other team members | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
34+
| Export team machines | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
3435
| Fork team projects and machines | ✅ Yes | ✅ Yes | ✅ Yes | 🚫 No |
3536
| Edit existing team projects | ✅ Yes | ✅ Yes | ✅ Yes | 🚫 No |
3637
| Create team projects | ✅ Yes | ✅ Yes | ✅ Yes | 🚫 No |
38+
| Lock team machines | ✅ Yes | ✅ Yes | ✅ Yes | 🚫 No |
3739
| Reassign Admin, Editor, and Viewer roles | ✅ Yes | ✅ Yes | 🚫 No | 🚫 No |
3840
| Invite new team members | ✅ Yes | ✅ Yes | 🚫 No | 🚫 No |
3941
| Change project visibility | ✅ Yes | ✅ Yes | 🚫 No | 🚫 No |
@@ -52,7 +54,8 @@ Pro subscribers can create teams and they become their teams' owner by default.
5254
- View team members
5355
- Give team members Admin, Editor, and Viewer roles
5456
- Create team projects
55-
- Edit, fork, and view team projects and machines
57+
- Lock team machines
58+
- Edit, fork, export, and view team projects and machines
5659

5760
#### Teams members and Pro plan seats
5861

@@ -68,22 +71,25 @@ Users with the Admin role can:
6871
- View team members
6972
- Give team members Editor and Viewer roles
7073
- Create team projects
71-
- Edit, fork, and view team projects and machines
74+
- Lock team machines
75+
- Edit, fork, export, and view team projects and machines
7276

7377
### Editor role
7478

7579
Users with the Editor role can:
7680

7781
- View team members
7882
- Create team projects
79-
- Edit, fork, and view team projects and machines
83+
- Lock team machines
84+
- Edit, fork, export, and view team projects and machines
8085

8186
### Viewer role
8287

8388
Users with the Viewer role can:
8489

8590
- View team members
8691
- View team projects and machines
92+
- Export team machines
8793

8894
## Create a team
8995

‎sidebars.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,12 @@ const sidebars = {
176176
},
177177
],
178178
},
179+
{
180+
"type": "doc",
181+
"label": "Lock machines",
182+
"id": "lock-machines",
183+
"className": "pro-feature"
184+
},
179185
"keyboard-shortcuts",
180186
'canvas-view-controls',
181187
'user-preferences'

‎static/pricing/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ <h2 class="pricing-heading">Professional</h2>
128128
<li class="pricing-text">Live simulation mode</li>
129129
<li class="pricing-text">Generate flows using AI ✨</li>
130130
<li class="pricing-text">Modify flows using AI ✨</li>
131+
<li class="pricing-text">Lock machines</li>
131132
<li class="pricing-text">Color states and transitions</li>
132133
<li class="pricing-text">Markdown export</li>
133134
<li class="pricing-text">Priority support</li>

‎versioned_docs/version-5/lock-machines.mdx

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Lock machines
3+
---
4+
5+
You can lock a machine anytime to prevent accidental edits. Locked machines have a <Lock size={18} /> **Locked** status displayed in the editor’s top bar.
6+
7+
Hover over the <Lock size={18} /> **Locked** text to view who locked the machine and when.
8+
9+
:::studio
10+
11+
Locking machines is a Pro feature of the Studio. [Check out the features on our Pro plan](/studio-pro-plan.mdx) or [upgrade to try the Pro plan with a 30-day free trial](https://stately.ai/registry/billing).
12+
13+
:::
14+
15+
Locking a machine prevents you, or anyone else on your team, from the following:
16+
17+
- Editing the machine
18+
- Deleting the machine
19+
- Renaming the machine
20+
- [Importing code](import-from-code.mdx) to replace the machine
21+
- [Restoring a past version](versions) of the machine
22+
23+
If somebody else is viewing or editing the machine when it is locked, their changes will not be saved, and they will be notified that the machine is now locked.
24+
25+
## How to lock and unlock a machine
26+
27+
From the editor menu, go to **Machine** > <Unlock size={18} /> **Lock machine** / <Lock size={18} /> **Unlock machine**.
28+
29+
From the machine’s <Info size={18} /> **Details** panel, use the <Unlock size={18} /> Lock machine / <Lock size={18} /> Unlock machine icon button.
30+
31+
## Team roles and locking machines
32+
33+
All team members can view locked machines. Only team owners, Admins, and Editors can lock and unlock machines.
34+
35+
| Capability | Owner | Admin | Editor | Viewer |
36+
| ----------------------- | ------ | ------ | ------ | ------ |
37+
| View locked machine | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
38+
| Lock and unlock machine | ✅ Yes | ✅ Yes | ✅ Yes | 🚫 No |

‎versioned_docs/version-5/studio-pro-plan.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ title: Stately Studio Pro plan
1313
- [Version history](/versions.mdx)
1414
- [Import from GitHub](/import-from-github.mdx)
1515
- [Live simulation mode](/live-simulation.mdx)
16+
- [Lock machines](/lock-machines.mdx)
1617
- [Color states and transitions](/colors.mdx)
1718
- [Priority support](/studio-pro-plan.mdx#priority-support)
1819
- GitHub Sync (coming soon!)

‎versioned_docs/version-5/teams.mdx

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,11 @@ The following table is an overview of the capabilities of each team role:
3131
| ---------------------------------------- | ------ | ------ | ------ | ------ |
3232
| View team projects and machines | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
3333
| View other team members | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
34+
| Export team machines | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
3435
| Fork team projects and machines | ✅ Yes | ✅ Yes | ✅ Yes | 🚫 No |
3536
| Edit existing team projects | ✅ Yes | ✅ Yes | ✅ Yes | 🚫 No |
3637
| Create team projects | ✅ Yes | ✅ Yes | ✅ Yes | 🚫 No |
38+
| Lock team machines | ✅ Yes | ✅ Yes | ✅ Yes | 🚫 No |
3739
| Reassign Admin, Editor, and Viewer roles | ✅ Yes | ✅ Yes | 🚫 No | 🚫 No |
3840
| Invite new team members | ✅ Yes | ✅ Yes | 🚫 No | 🚫 No |
3941
| Change project visibility | ✅ Yes | ✅ Yes | 🚫 No | 🚫 No |
@@ -52,7 +54,8 @@ Pro subscribers can create teams and they become their teams' owner by default.
5254
- View team members
5355
- Give team members Admin, Editor, and Viewer roles
5456
- Create team projects
55-
- Edit, fork, and view team projects and machines
57+
- Lock team machines
58+
- Edit, fork, export, and view team projects and machines
5659

5760
#### Teams members and Pro plan seats
5861

@@ -68,22 +71,26 @@ Users with the Admin role can:
6871
- View team members
6972
- Give team members Editor and Viewer roles
7073
- Create team projects
71-
- Edit, fork, and view team projects and machines
74+
- Lock team machines
75+
- Edit, fork, export, and view team projects and machines
7276

7377
### Editor role
7478

7579
Users with the Editor role can:
7680

7781
- View team members
7882
- Create team projects
79-
- Edit, fork, and view team projects and machines
83+
- Lock team machines
84+
- Edit, fork, export, and view team projects and machines
8085

8186
### Viewer role
8287

8388
Users with the Viewer role can:
8489

8590
- View team members
8691
- View team projects and machines
92+
- Export team machines
93+
8794

8895
## Create a team
8996

‎versioned_sidebars/version-5-sidebars.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,12 @@
211211
}
212212
]
213213
},
214+
{
215+
"type": "doc",
216+
"label": "Lock machines",
217+
"id": "lock-machines",
218+
"className": "pro-feature"
219+
},
214220
"keyboard-shortcuts",
215221
"canvas-view-controls",
216222
"user-preferences"

0 commit comments

Comments
 (0)