docs(scout): standardise command name to 'environment' in _index.md#25123
docs(scout): standardise command name to 'environment' in _index.md#25123mohithshuka wants to merge 5 commits into
Conversation
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
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR aims to improve documentation consistency by standardizing command naming in the Docker Scout “environments” integration docs, but it also includes an additional (and currently problematic) update to the Docker daemon configuration docs.
Changes:
- Updates Scout environments docs to prefer
docker scout environmentoverdocker scout envin multiple places. - Modifies console examples and prose in the Scout environments page (but leaves some inconsistent
envreferences and introduces a duplicated sentence). - Adds a new “Configuration using environment variables” section to the Docker daemon docs, but the Markdown fencing and the systemd example appear incorrect/incomplete.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| content/manuals/scout/integrations/environment/_index.md | Standardizes command naming toward docker scout environment, but still contains inconsistent env prose, a copy/paste formatting issue, and duplicated text. |
| content/manuals/engine/daemon/_index.md | Expands daemon configuration documentation to include environment variables, but introduces internal wording inconsistencies and broken Markdown fences; also expands PR scope beyond stated intent. |
Comments suppressed due to low confidence (7)
content/manuals/scout/integrations/environment/_index.md:56
- The console example has an extra space after
$($ docker ...), which makes copy/paste awkward and inconsistent with other console blocks in this doc. Remove the extra space so the prompt formatting is consistent.
```console
$ docker scout environment
**content/manuals/scout/integrations/environment/_index.md:102**
* These two lines duplicate the same sentence, and the first has incorrect capitalization (“you can Use”). Collapse to a single sentence with correct casing.
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.
**content/manuals/scout/integrations/environment/_index.md:56**
* The PR description says terminal command examples were already correct and left unchanged, but this hunk updates the examples from `docker scout env` to `docker scout environment`. Please update the PR description (or revert the example changes) so it accurately reflects what changed.
docker scout env command.
$ docker scout environment**content/manuals/engine/daemon/_index.md:49**
* After introducing a third configuration method, this paragraph still says “both of these options”, which is now ambiguous/incorrect. Reword to explicitly refer to the JSON file + flags (or update the explanation to include how environment variables interact).
There are three ways to configure the Docker daemon:
- Use a JSON configuration file. This is the preferred option, since it keeps
all configurations in a single place. - 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
option both as a flag and in the JSON file. If that happens, the Docker daemon
won't start and prints an error message.
**content/manuals/engine/daemon/_index.md:114**
* The new section’s fenced code blocks use inconsistent/invalid backtick counts (e.g. ````````console / ``````ini / ````console), which will likely break Markdown rendering. Use standard triple-backtick fences consistently for each block.
To set environment variables for the Docker daemon using systemd, create a
drop-in override file:
$ sudo systemctl edit docker
```````
Add the following:
``````ini
[Service]
Environment="DOCKER_OPTS=--debug --tls=true"
`````
```
**content/manuals/engine/daemon/_index.md:113**
* As written, the systemd drop-in only sets `DOCKER_OPTS`, but doesn’t show how that variable is applied to `dockerd` (e.g., via an `ExecStart` override that references it). Either document the full, working systemd override pattern (similar to `remote-access.md`) or change the example to a mechanism that is guaranteed to affect `dockerd` (daemon.json or explicit flags).
```
### Configuration using environment variables
You can configure the Docker daemon using environment variables. This is useful
in systemd service overrides or init scripts.
To set environment variables for the Docker daemon using systemd, create a
drop-in override file:
````````console
$ sudo systemctl edit docker
```````
Add the following:
``````ini
[Service]
Environment="DOCKER_OPTS=--debug --tls=true"
`````
```
**content/manuals/engine/daemon/_index.md:106**
* Other Engine docs use `systemctl edit docker.service` / `restart docker.service` when describing systemd overrides. For consistency (and to avoid ambiguity on systems with similarly named units), consider using the explicit `docker.service` unit name here too.
```
To set environment variables for the Docker daemon using systemd, create a
drop-in override file:
````````console
$ sudo systemctl edit docker
```````
```
</details>
---
💡 <a href="/docker/docs/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.| To see all of the available environments for an organization, you can use the | ||
| `docker scout env` command. | ||
|
|
||
| ```console | ||
| $ docker scout env | ||
| $ docker scout environment | ||
| ``` |
| ## Configure the Docker daemon | ||
|
|
||
| There are two ways to configure the Docker daemon: | ||
| There are three ways to configure the Docker daemon: | ||
|
|
||
| - Use a JSON configuration file. This is the preferred option, since it keeps | ||
| all configurations in a single place. | ||
| - Use flags when starting `dockerd`. | ||
| - Use environment variables to set daemon options. |
What does this PR do?
Fixes inconsistent command name usage in the Scout environment integration docs.
The
_index.mdpage mixeddocker scout envanddocker scout environmentinterchangeably in prose descriptions. Updated all prose references to use
the canonical
docker scout environmentform, which matches theofficial CLI reference.
Related issue
Closes #25085
Type of change
Changes made
File:
content/manuals/scout/integrations/environment/_index.mddocker scout env→docker scout environmentin two prose sentences$ docker scout environment) were already correct and left unchangedChecklist