docs: remove deprecated --keep flag from tutorials and examples#2126
Open
Ygnas wants to merge 1 commit into
Open
docs: remove deprecated --keep flag from tutorials and examples#2126Ygnas wants to merge 1 commit into
Ygnas wants to merge 1 commit into
Conversation
The --keep flag is deprecated, hidden, and a no-op since sandboxes are kept by default. Remove references from tutorial docs and example READMEs that explain it as a real feature. - Remove --keep from sandbox create commands - Remove --keep explanation text - Clarify that sandboxes are kept by default Signed-off-by: Ignas Baranauskas <ibaranau@redhat.com>
|
All contributors have signed the DCO ✍️ ✅ |
Author
|
I have read the DCO document and I hereby sign the DCO. |
Author
|
recheck |
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
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
Remove references to the deprecated
--keepflag from tutorials and exampleREADMEs. The flag is hidden (
hide = true), deprecated, and a no-op sincesandboxes are kept by default. Users following these docs were being taught
to use a flag that does nothing.
Related Issue
N/A — standalone docs correction. The
--keepflag is declared deprecatedat
crates/openshell-cli/src/main.rs:1247-1249but tutorials and examplesstill explained it as an active feature.
Changes
--keepfromsandbox createcommands in tutorials and examples--keepexplanation text that described it as a real feature--no-keepmentions where sandbox persistence is explained, so usersknow how to opt into auto-deletion
docs/get-started/tutorials/first-network-policy.mdxdocs/get-started/tutorials/microsoft-graph-provider-refresh.mdxexamples/sandbox-policy-quickstart/README.mdexamples/policy-advisor/README.mdexamples/spiffe-token-grant-demo/README.mdscripts/agents/gator/README.mdTesting
mise run pre-commitpassesChecklist