diff --git a/docs/planning/assets/snapshots/planMetadataPane.png b/docs/planning/assets/snapshots/planMetadataPane.png new file mode 100644 index 0000000..fa27d32 --- /dev/null +++ b/docs/planning/assets/snapshots/planMetadataPane.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:211adcf2161d1dae217a58f83506d23ee4f3f4d747e6aee528f7f482ecf8eda4 +size 145986 diff --git a/docs/planning/assets/snapshots/restoreSnapshotModal.png b/docs/planning/assets/snapshots/restoreSnapshotModal.png new file mode 100644 index 0000000..1b1b646 --- /dev/null +++ b/docs/planning/assets/snapshots/restoreSnapshotModal.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:31e0f1861cbc6ed853906305a6ada3cfb221bd0fdcccfc374d6218795c729aac +size 41987 diff --git a/docs/planning/assets/snapshots/restoreSnapshotTakeSnapshot.png b/docs/planning/assets/snapshots/restoreSnapshotTakeSnapshot.png new file mode 100644 index 0000000..d2a3d53 --- /dev/null +++ b/docs/planning/assets/snapshots/restoreSnapshotTakeSnapshot.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b85de39ad83e6d6dc7a503cdde49997e1fadaafad3c18f3fb5a1a5d9a8fe56cd +size 69251 diff --git a/docs/planning/assets/snapshots/takeSnapshotModal.png b/docs/planning/assets/snapshots/takeSnapshotModal.png new file mode 100644 index 0000000..9affed1 --- /dev/null +++ b/docs/planning/assets/snapshots/takeSnapshotModal.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:8098539fb50bc5fa235bac659a173de08f58a94fc19b84bf0fb9d904500ec85c +size 71496 diff --git a/docs/planning/assets/snapshots/takeSnapshotNavbar.png b/docs/planning/assets/snapshots/takeSnapshotNavbar.png new file mode 100644 index 0000000..da12501 --- /dev/null +++ b/docs/planning/assets/snapshots/takeSnapshotNavbar.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a5b0a80e968ad4fab457c541c8c80d6492e20acb485711a435a43a7d17326761 +size 56999 diff --git a/docs/planning/assets/snapshots/viewSnapshot.png b/docs/planning/assets/snapshots/viewSnapshot.png new file mode 100644 index 0000000..f1a1d1b --- /dev/null +++ b/docs/planning/assets/snapshots/viewSnapshot.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:c30847cde99938ea7b8fe3917c031fb04bf914b05a8c3f57b90420fee108a421 +size 668036 diff --git a/docs/planning/assets/snapshots/viewSnapshotNavbar.png b/docs/planning/assets/snapshots/viewSnapshotNavbar.png new file mode 100644 index 0000000..137da00 --- /dev/null +++ b/docs/planning/assets/snapshots/viewSnapshotNavbar.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ac2a5b018534e96ac580dcd950bdc8a9a7784aa3ce97cf1e777a0c99f5e36fca +size 56804 diff --git a/docs/planning/snapshots.mdx b/docs/planning/snapshots.mdx new file mode 100644 index 0000000..f521869 --- /dev/null +++ b/docs/planning/snapshots.mdx @@ -0,0 +1,81 @@ +import takeSnapshotNavbar from './assets/snapshots/takeSnapshotNavbar.png'; +import takeSnapshotModal from './assets/snapshots/takeSnapshotModal.png'; + +import viewSnapshotNavbar from './assets/snapshots/viewSnapshotNavbar.png'; +import planMetadataPane from './assets/snapshots/planMetadataPane.png'; +import viewSnapshot from './assets/snapshots/viewSnapshot.png'; + +import restoreSnapshotModal from './assets/snapshots/restoreSnapshotModal.png'; +import restoreAndTakeSnapshot from './assets/snapshots/restoreSnapshotTakeSnapshot.png'; + +# Snapshots + +A snapshot of a plan is a named record of the state of all activities in a plan at a certain time. +Snapshots are useful for recording and returning to known "good" states of a plan. + + + +## Taking a Snapshot + +Snapshots can via one of two methods: +1. Clicking on the Plan's name in the navbar, then clicking "Take Snapshot" +2. Clicking on the "Take Snapshot" button in the Plan Metadata Pane + +Either option will then present you with a modal where you can name the snapshot and optionally provide a description and tags. +Note that snapshot names must be unique per plan. + +
+
+ Aerie UI - Expanded drop down under Plan in the Navbar, the option 'Take Snapshot' is highlighted +
+ Aerie UI - Take Snapshot Modal +
Figure 1: Aerie UI - How to Take a Plan Snapshot
+
+ + +## Viewing a Snapshot + +You can view the snapshots taken for a specific plan by clicking on the Plan's name in the navbar, then clicking "View Snapshot History". +Doing so will open the Plan Metadata Pane, where a list of all snapshots taken will be displayed. +If a snapshot has been simulated, an icon will be present indicating the results of the most recent simulation for that snapshot. + +You can filter this list to only display snapshots for the currently selected simulation dataset by selecting the "Snapshot" badge to the left of the "Take Snapshot" button. + +
+
+ Aerie UI - Expanded drop down under Plan in the Navbar, the option 'View Snapshot' is highlighted +
+ Aerie UI - Plan Metadata Pane +
Figure 2: Aerie UI - How to View a Plan Snapshot
+
+ +Clicking on a snapshot will open a preview of its contents. From here, you can examine activities and related simulation datasets. + +
+ Aerie UI - Take Snapshot Modal +
Figure 3: Aerie UI - Viewing a Plan Snapshot
+
+ +## Restoring a Snapshot + +If you would like to update a plan to match the state of a snapshot, you can do so by clicking on the "Restore Snapshot" button seen while previewing a snapshot. + +When restoring a snapshot, you can optionally choose to take a snapshot of the current state of the plan prior to restoring. + +
+
+ Aerie UI - Restore Snapshot Modal +
+ Aerie UI - Restore and Take Snapshot Modal - Simple +
Figure 4: Aerie UI - How to Restore a Plan Snapshot
+
+ +The snapshot you restored will remain in the list in case you need to restore to it again in the future. diff --git a/sidebars.js b/sidebars.js index 507be6c..fde5481 100644 --- a/sidebars.js +++ b/sidebars.js @@ -119,6 +119,7 @@ const sidebars = { }, items: ['planning/collaboration/merging-plans'], }, + 'planning/snapshots', 'planning/anchors', 'planning/ui-views', 'planning/timeline-editing',