docs: clarify docker context use affects all terminal sessions#6840
Open
vibhuanand wants to merge 1 commit intodocker:masterfrom
Open
docs: clarify docker context use affects all terminal sessions#6840vibhuanand wants to merge 1 commit intodocker:masterfrom
vibhuanand wants to merge 1 commit intodocker:masterfrom
Conversation
Signed-off-by: Vibhu <vibhuanand@outlook.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Fixes #3064
- What I did
Clarified the behavior of
docker context usein the CLI documentation.The docs now explicitly mention that this command updates the Docker CLI configuration and therefore changes the default context globally (affecting all terminal sessions).
Added examples showing how to temporarily select a context using:
DOCKER_CONTEXTenvironment variable--contextflag for individual commands- How I did it
Updated the documentation file:
docs/reference/commandline/context_use.md
Added explanation that
docker context usemodifies the CLI config and is therefore "sticky". Also added examples demonstrating safer alternatives for temporary context selection.- How to verify it
Open the updated documentation page:
docs/reference/commandline/context_use.md
Confirm the description explains that:
docker context usemodifies the CLI configConfirm examples exist for:
docker --context <context>export DOCKER_CONTEXT=<context>- Human readable description for the release notes
- A picture of a cute animal (not mandatory but encouraged)