Skip to content

dhi: cli quick ref update#24692

Open
craig-osterhout wants to merge 2 commits intodocker:mainfrom
craig-osterhout:dhi-custom-feedback
Open

dhi: cli quick ref update#24692
craig-osterhout wants to merge 2 commits intodocker:mainfrom
craig-osterhout:dhi-custom-feedback

Conversation

@craig-osterhout
Copy link
Copy Markdown
Contributor

@craig-osterhout craig-osterhout commented Apr 10, 2026

Description

Added that for edit, the yaml must have the id.
Added that this is a quick ref with an xref to the CLI ref for more details.

https://deploy-preview-24692--docsdocker.netlify.app/dhi/how-to/cli/

Related issues or tickets

https://docker.slack.com/archives/C04M34MRQS1/p1775854248771389

Reviews

  • Editorial review

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 10, 2026

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 4622c56
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/69d968c1897e2d0008eec529
😎 Deploy Preview https://deploy-preview-24692--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@craig-osterhout
Copy link
Copy Markdown
Contributor Author

/review

@craig-osterhout craig-osterhout requested a review from a team April 10, 2026 21:11
@craig-osterhout craig-osterhout added the status/review Pull requests that are ready for review label Apr 10, 2026
@craig-osterhout craig-osterhout enabled auto-merge (squash) April 10, 2026 21:11
Copy link
Copy Markdown
Contributor

@docker-agent docker-agent bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assessment: 🟢 APPROVE

This PR improves the DHI CLI documentation by:

  1. Adding a cross-reference: Links to the full CLI reference for users who need complete details on all options and flags
  2. Clarifying the edit command: Adds a helpful comment explaining that the YAML file must include the 'id' field

Both changes enhance documentation clarity and follow the Docker documentation style guide. No issues found.

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/dhi status/review Pull requests that are ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant