docs: clarify interpolation precedence vs container env precedence#25349
Open
mohithshuka wants to merge 12 commits into
Open
docs: clarify interpolation precedence vs container env precedence#25349mohithshuka wants to merge 12 commits into
mohithshuka wants to merge 12 commits into
Conversation
added 12 commits
May 15, 2026 16:36
The previous description said 'optimize your repository storage' which was vague and did not reflect the page's actual content. The manage.md page is focused on viewing, filtering, and deleting images and image indexes. Updated the description to accurately reflect this. Fixes docker#25005
The daemon configuration overview only mentioned two methods (JSON file and flags) but was missing the environment variables method via systemd. Added a new section explaining how to use systemd drop-in overrides to set daemon environment variables. Fixes docker#25062
Replace shorthand alias 'docker scout env' with the full canonical command name 'docker scout environment' in the environment integration overview page, matching the CLI reference and cli.md usage. Closes docker#25085
The _index.md page mixed 'docker scout env' and 'docker scout environment' interchangeably. The CLI reference uses 'environment' as the canonical name, so prose references are updated to match. Fixes docker#25085
…ct example Fixes docker#25192 useState was used on line 286 but was missing from the import statement, causing an error if users follow the tutorial literally.
The React code example was using useState, useEffect, and createDockerDesktopClient without importing them, which would cause errors for anyone copy-pasting the snippet. Fixes docker#25192
…rial The createDockerDesktopClient() was declared twice - once at module level (correct) and again inside the App() function (redundant/incorrect). Removed the duplicate declaration inside the function. Fixes docker#25192
The Docker driver page did not mention that multi-platform builds are unsupported, which caused confusion when users encountered runtime errors. Added a Limitations section that clearly states this and links to alternatives. Fixes docker#25044
- Moved Limitations section before Further reading - Corrected multi-platform statement: it depends on the storage driver, not a blanket limitation. Containerd snapshotters (default in Docker Engine v29.x+) support multi-platform builds, while legacy graph-drivers do not. Based on review feedback from thaJeztah.
Fixes docker#25337 - Fix broken sentence in .env file additional information section ('that as' -> 'that are also set as') - Add note clarifying that interpolation precedence is distinct from container environment variable precedence, linking to the dedicated precedence page to reduce confusion
❌ Deploy Preview for docsdocker failed. Why did it fail? →
|
github-actions
Bot
added
area/engine
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates several documentation pages to reflect new/updated CLI commands and improve guidance around configuration and multi-platform builds.
Changes:
- Update Docker Scout “environment” command references and examples.
- Adjust Extensions SDK snippets to create the Docker Desktop client once at module scope.
- Expand/clarify docs on daemon configuration, QEMU installation context, and Buildx Docker driver limitations.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| content/manuals/scout/integrations/environment/_index.md | Updates CLI command references/examples for environments, but introduces duplication/inconsistencies. |
| content/manuals/extensions/extensions-sdk/guides/invoke-host-binaries.md | Moves ddClient initialization outside the component; adds unexpected leading blank lines before front matter. |
| content/manuals/extensions/extensions-sdk/build/backend-extension-tutorial.md | Aligns tutorial snippet with module-scoped ddClient and adds useState import. |
| content/manuals/engine/daemon/_index.md | Adds environment-variable configuration section; contains rendering issues and potentially misleading systemd guidance. |
| content/manuals/compose/how-tos/environment-variables/variable-interpolation.md | Fixes grammar but leaves formatting (double-space) issue. |
| content/manuals/build/building/multi-platform.md | Clarifies when manual QEMU installation is required. |
| content/manuals/build/builders/drivers/docker.md | Adds limitations section; references a likely non-existent/future Docker Engine version. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -52,15 +52,15 @@ To see all of the available environments for an organization, you can use the | |||
| `docker scout env` command. | |||
Comment on lines
+101
to
+102
| Alternatively, you can Use the `docker scout environment` command to view the images from the terminal. | ||
| use the `docker scout environment` command to view the images from the terminal. |
Comment on lines
+1
to
7
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| --- |
| - Use flags when starting `dockerd`. | ||
| - Use environment variables to set daemon options. | ||
|
|
||
| You can use both of these options together as long as you don't specify the same |
|
|
||
| To set environment variables for the Docker daemon using systemd, create a | ||
| drop-in override file: | ||
|
|
Comment on lines
+111
to
+112
| [Service] | ||
| Environment="DOCKER_OPTS=--debug --tls=true" |
| > [!IMPORTANT] | ||
| > | ||
| > Be aware of [Environment variables precedence](envvars-precedence.md) when using variables in an `.env` file that as environment variables in your container's environment. | ||
| > Be aware of [Environment variables precedence](envvars-precedence.md) when using variables in an `.env` file that are also set as environment variables in your container's environment. |
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.
What does this PR do?
Improves the variable interpolation documentation to address confusion
between interpolation precedence and container environment variable
precedence.
Changes
.envfile section(
"that as"→"that are also set as")interpolation page applies only to how
${VAR}expressions areresolved in the Compose file, and is separate from the container
environment variable precedence documented in
envvars-precedence.mdRelated issues
Fixes #25337