Skip to content
This repository was archived by the owner on Dec 5, 2024. It is now read-only.

Commit 549406a

Browse files
author
Meaghan Lewis
committed
add documentation for file locks
1 parent 9a08719 commit 549406a

File tree

6 files changed

+41
-0
lines changed

6 files changed

+41
-0
lines changed

docs/using/images/locked-scene.png

Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading

docs/using/images/locks-view.png

Lines changed: 3 additions & 0 deletions
Loading

docs/using/images/release-lock.png

Lines changed: 3 additions & 0 deletions
Loading

docs/using/images/request-lock.png

Lines changed: 3 additions & 0 deletions
Loading

docs/using/locking-files.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Locking files
2+
3+
## Request locks
4+
5+
From the Project tab, right-click on a file to open the context menu and select `Request Lock`.
6+
<img src="images/request-lock.png"/>
7+
8+
## View locks
9+
10+
After requesting a lock, a lock icon appears in the bottom right-hand corner of the file.
11+
<img src="images/locks-view.png"/>
12+
13+
A list of all locked files will appear in the **Locks** view in the GitHub tab.
14+
<img src="images/locked-scene.png"/>
15+
16+
## Release locks
17+
18+
There are two ways to release locks:
19+
20+
1. From the Project tab, right-click on the locked file to open the context menu and select the option to `Release Lock`.
21+
<img src="images/release-lock.png"/>
22+
23+
2. From the GitHub tab under **Locks** view, right-click to open the context menu and select to `Release Lock`.
24+
<img src="images/locks-view-right-click.png"/>
25+
26+
There are also two options for how to release a lock on a file. Always choose the `Release Lock` option first. The `Release Lock (forced)` option can be used to remove someone else's lock.

0 commit comments

Comments
 (0)