workflow snapshots documentation #516
Conversation
There was a problem hiding this comment.
@ritazagoni left some questions/comments for you to check out pls. Ty!
|
|
||
|  | ||
|
|
||
| ### Retrying a Snapshot |
There was a problem hiding this comment.
@ritazagoni so does this mean that you cannot retry a workflow with a specific snapshot? Then I think we should say that explicitly
| 1. When a user saves changes to their workflow either through the canvas or the job editor | ||
| 2. When a run is made either by creating a new work order or retrying a run | ||
|
|
||
| ### How can I view a snapshot? |
There was a problem hiding this comment.
@ritazagoni @christad92 so confirming there's no one central list view of all my snapshots somewhere, right?
There was a problem hiding this comment.
No. We don't have an interface for viewing the list of snapshots right now.
docs/build/workflow-snapshots.md
Outdated
|
|
||
| ### When is a snapshot made? | ||
| Snapshots are created in 2 ways: | ||
| 1. When a user saves changes to their workflow either through the canvas or the job editor |
There was a problem hiding this comment.
What do you mean by "job editor"? Do you mean the Inspector? That's what we're calling it in our current docs
@ritazagoni
docs/build/workflow-snapshots.md
Outdated
| slug: /workflow-snapshots | ||
| --- | ||
|
|
||
| Workflow snapshots capture and store the state of a workflow and job code at a specific point in time based on a save operation and/or run. Snapshots are helpful with debugging, auditing, and improving overall workflow performance. |
There was a problem hiding this comment.
@ritazagoni what is the "state of a workflow" vs. "job code"?
Also I'm worried "state" will be confused with job "state"... what if we changed this language to something like the below (assuming the below is accurate)?
Workflow snapshots capture and store the state/version of a workflow's configuration and job code at a specific point in time, when a workflow was updated or run.
docs/build/workflow-snapshots.md
Outdated
|
|
||
|  | ||
|
|
||
| This will open the inspector screen for that step in the run with all associated artifacts: logs and input/output data. On the inspector, you'll notice that you're in a read-only mode, and hovering on the workflow snapshot ID chip, you’ll see a message that reads “You are viewing a snapshot of this workflow that was taken on ….” |
There was a problem hiding this comment.
Should we link to this existing docs page for more on the Inspector?
https://docs.openfn.org/documentation/build/steps/step-editor
docs/build/workflow-snapshots.md
Outdated
| Similar to viewing a snapshot by inspecting a step, you can click the inspect icon in front of the steps to open the inspector for the step. | ||
|
|
||
| ### Editing a Snapshot | ||
| Snapshots are read-only and serve as a reference for the state of a workflow when saved or a run is executed. To enable editing more, users can either click on the `Switch to latest version` on the canvas or use the toggle at the bottom right of the inspector page to switch to the latest version of the workflow. |
There was a problem hiding this comment.
"To enable editing more" ... more what?
|
|
||
|  | ||
|
|
||
| ### Retrying a Snapshot |
There was a problem hiding this comment.
Can we add a ### Version Control section to briefly summarize how snapshotting is different than version control, and then link to our existing docs page on Github version control?
|
@ritazagoni , what's your ETA for addressing @aleksa-krolls 's requested changes? If still several days out, it might make sense to ask @christad92 to implement the requested changes instead and then merge this. |
@taylor I should be done with them tomorrow |
|
@aleksa-krolls I've incorporated the changes |
docs on new workflow snapshots feature