docs: remove duplicate step in GitHub Actions workflow example#25139
docs: remove duplicate step in GitHub Actions workflow example#25139mohithshuka 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 updates Docker documentation pages related to Docker Scout environments and Docker Engine daemon configuration. Note: the PR title/description references a GitHub Actions workflow example (checks.md), but the provided diffs modify different files.
Changes:
- Update Docker Scout environments documentation to use
docker scout environmentin CLI examples. - Add a new “Configuration using environment variables” section to the Docker daemon configuration overview.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| content/manuals/scout/integrations/environment/_index.md | Updates CLI command examples for managing Scout environments, but introduces duplicated/incorrect text and formatting inconsistencies. |
| content/manuals/engine/daemon/_index.md | Adds daemon configuration guidance via environment variables, but includes Markdown fence issues and potentially misleading systemd instructions. |
Comments suppressed due to low confidence (2)
content/manuals/scout/integrations/environment/_index.md:68
- This paragraph says the default organization setting affects all
docker scoutcommands “not justenv”, but the page now documentsdocker scout environment. Update this wording toenvironment(or mention the alias) to avoid inconsistency.
```console
$ docker scout environment --org <org>
You can use the docker scout config command to change the default
organization. This changes the default organization for all docker scout
commands, not just env.
**content/manuals/engine/daemon/_index.md:49**
* After changing this section to “three ways”, the next paragraph still says “both of these options together”, which is now ambiguous/incorrect. Please reword to clearly describe which configuration methods can be combined and what the precedence/conflict rules are.
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.
</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 | ||
| ``` |
| 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. |
| To add environments to Docker Scout, you can: | ||
|
|
||
| - Use the `docker scout env <environment> <image>` CLI command to record images to environments manually | ||
| - Use the `docker scout environment <environment> <image>` CLI command to record images to environments manually | ||
| - Enable a runtime integration to automatically detect images in your environments. |
| ````````console | ||
| $ sudo systemctl edit docker | ||
| ``````` | ||
|
|
||
| Add the following: | ||
|
|
||
| ``````ini | ||
| [Service] | ||
| Environment="DOCKER_OPTS=--debug --tls=true" | ||
| ````` | ||
|
|
||
| Then reload and restart the daemon: | ||
|
|
||
| ````console | ||
| $ sudo systemctl daemon-reload | ||
| $ sudo systemctl restart docker | ||
| ``` |
| 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" | ||
| ````` | ||
|
|
||
| Then reload and restart the daemon: | ||
|
|
||
| ````console | ||
| $ sudo systemctl daemon-reload | ||
| $ sudo systemctl restart docker |
What does this PR do?
Fixes a duplicate
docker/build-push-actionstep in the build checksGitHub Actions example (
checks.md).Previously, the workflow ran
build-push-actiontwice:call: checkto validate the build configurationpush: trueto build and push the imageThese have been consolidated into a single step.
Also fixes
DOCKERHUB_USERNAMEto usevarsinstead ofsecrets,consistent with all other examples in this directory.
Related issues
Fixes #25015
Checklist