Open
Conversation
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
|
/review |
1 task
Contributor
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
This PR improves the DHI CLI documentation by:
- Adding a cross-reference: Links to the full CLI reference for users who need complete details on all options and flags
- 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>
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.
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