Skip to content

Commit 87619f2

Browse files
committed
Document the machine locking feature
1 parent aafdbec commit 87619f2

File tree

4 files changed

+86
-0
lines changed

4 files changed

+86
-0
lines changed

docs/lock-machines.mdx

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
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+
- Delete the machine
19+
- Rename the machine
20+
- [Import code](import-from-code.mdx) to replace the machine
21+
22+
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.
23+
24+
## How to lock and unlock a machine
25+
26+
From the editor menu, go to **Machine** > <Unlock size={18} /> **Lock machine** / <Lock size={18} /> **Unlock machine**.
27+
28+
From the machine’s <Info size={18} /> **Details** panel, use the <Unlock size={18} /> Lock machine / <Lock size={18} /> Unlock machine icon button.
29+
30+
## Team roles and locking machines
31+
32+
All team members can view locked machines. Only team owners, Admins, and Editors can lock and unlock machines.
33+
34+
| Capability | Owner | Admin | Editor | Viewer |
35+
| ------------------------------------ | ------ | ------ | ------ | ------ |
36+
| View locked machine | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
37+
| Lock and unlock machine | ✅ Yes | ✅ Yes | ✅ Yes | 🚫 No |

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'
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
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+
- Delete the machine
19+
- Rename the machine
20+
- [Import code](import-from-code.mdx) to replace the machine
21+
22+
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.
23+
24+
## How to lock and unlock a machine
25+
26+
From the editor menu, go to **Machine** > <Unlock size={18} /> **Lock machine** / <Lock size={18} /> **Unlock machine**.
27+
28+
From the machine’s <Info size={18} /> **Details** panel, use the <Unlock size={18} /> Lock machine / <Lock size={18} /> Unlock machine icon button.
29+
30+
## Team roles and locking machines
31+
32+
All team members can view locked machines. Only team owners, Admins, and Editors can lock and unlock machines.
33+
34+
| Capability | Owner | Admin | Editor | Viewer |
35+
| ------------------------------------ | ------ | ------ | ------ | ------ |
36+
| View locked machine | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
37+
| Lock and unlock machine | ✅ Yes | ✅ Yes | ✅ Yes | 🚫 No |

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)