Skip to content

Commit 4830d72

Browse files
authored
Merge pull request #4294 from FlowFuse/3818-docs
update docs for snapshot edit
2 parents d46a226 + 02d6655 commit 4830d72

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

docs/user/envvar.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,7 @@ In addition, the following variables are set when running on a device:
6262

6363
When deploying the same set of flows out to multiple devices, these variables can
6464
be used by the flows to identify the specific device being run on.
65+
66+
NOTE: `FF_SNAPSHOT_NAME` will not be immediately updated when the current snapshot is edited.
67+
It will only be updated when the snapshot is changed or a setting that causes the device to
68+
be restarted is changed.

docs/user/snapshots.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,20 @@ To create a snapshot:
2424

2525
The list of snapshots will update with the newly created entry at the top.
2626

27+
## Edit a snapshot
28+
29+
To edit a snapshot:
30+
31+
1. Go to the instance's page and select the **Snapshots** tab.
32+
2. Open the dropdown menu to the right of the snapshot you want to edit and
33+
select the **Edit Snapshot** option.
34+
3. Update the name and description as required.
35+
4. Click **Update**
36+
37+
NOTE:
38+
Changes made to a snapshot will not be immediately reflected on devices that are already running this snapshot.
39+
40+
2741
## Download a snapshot
2842

2943
A snapshot can be downloaded to your local machine for backup or sharing.

0 commit comments

Comments
 (0)