Sandboxes: corrections, new sections, and screenshots#790
Merged
Conversation
Rewrites docs/build/sandboxes.md against the current release/2.16.4
behavior in Lightning. Existing copy was accurate when written but had
drifted: credentials are shared with the parent (not duplicated),
subscription/billing is shared, sandboxes are scheduled for deletion
(not destroyed) after merging, triggers start disabled, etc.
Adds:
- Who can do what role table (with the visibility rule from #4763)
- Restoring a deleted sandbox
- Limits (active sandbox count, nesting depth)
- Per-tab Settings inheritance breakdown (matches the banners)
- Webhook auth methods (parent-managed via the Webhook Security tab)
- Channels not cloned at provision
- CLI auto-aliasing for sandboxes + checkout for multi-sandbox work
Fixes:
- Conflicts section was describing a non-existent "force the merge"
toggle. Real UX is per-workflow Changed / Diverged / New / Deleted
in sandbox tags; rewrote to match.
- "Destroyed after merging" was wrong; it's soft-delete with the
configured grace period, restorable from the sandboxes list.
- Three typo fixes.
Adds six screenshots matching the surrounding docs style.
elias-ba
changed the title
Collaborator
josephjclark
left a comment
josephjclark
left a comment
There was a problem hiding this comment.
Thanks @elias-ba, some great catches here. I've left a couple of suggestions
- Fix run history and dataclips framing: sandboxes start empty, they aren't 'private copies' of the parent. - Drop the 'follows from these rules' subsection in 'Who can do what' and the breadcrumb / picker-collapse tangents. - Rewrite 'Viewing a sandbox' entry instructions for users not yet inside a project; add the Ctrl/Cmd+P shortcut. - Correct the app-color claim: only the project picker pill changes color, not the whole UI. - Reword the collections merge paragraph to emphasise that relationships merge but data doesn't. - Clarify 'source' in the merge permission paragraph. - Remove env from the sandbox-card Edit action; it's only editable from the Settings page. - Trim the project-settings bullet and drop the niche channels line.
Contributor
Author
|
Thanks for the careful review, I pushed a commit addressing all seven inline comments. While I was in there, I also did an audit pass on the rest of the doc and caught a few more mismatches that I corrected. Can you give me another round of review ? Feel free to edit and push commits too. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites
docs/build/sandboxes.mdagainst the currentrelease/2.16.4behaviour in Lightning.Corrections
Sandboxes.clone_credentials_from_parent/2only copies theproject_credentialslink; the credentials themselves are shared.Subscriptionbelongs_to :projectis constrained to root projects (sandboxes share their parent's subscription), so usage in a sandbox counts toward the parent's allowances.clone_triggers_with_disabled_state/2setsenabled: falseunconditionally.Changed/Diverged/New/Deleted in sandboxtags in the merge confirmation modal.seperate,worklow,pushed).New sections
User.roleis a user type, not a project role.:local,:editable,:inherited, plus the parent-managed Webhook Security tab).openfn project fetchauto-aliases sandboxes;openfn project checkoutswitches between them.AI Usage