dhi: sync cli ref#25634
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. |
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🔴 CRITICAL
This PR edits vendored/generated files directly. Per AGENTS.md, CLI reference data under data/cli/ is vendored from upstream repositories and must not be edited in this repo — changes must go to the source repository and be synced back.
Affected files (vendored — do not edit here):
data/cli/dhi/docker_dhi_customization_build_get.yamldata/cli/dhi/docker_dhi_customization_build_list.yamldata/cli/dhi/docker_dhi_customization_build_logs.yaml
These files are generated from an upstream source. The usage signature changes (<repository> <name> <build-id> → <customization-id> <build-id>) need to be made in the upstream dhictl repo and synced back via the normal vendor process. Editing them here risks being overwritten the next time a sync runs.
The hand-authored changes in content/guides/dhi-backstage.md and content/manuals/dhi/release-notes/cli.md look good — no style violations found.
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🔴 CRITICAL
This PR directly edits three vendored CLI YAML files in data/cli/dhi/, which violates the repo's vendoring policy. Changes to these files must originate upstream and be synced back. Additionally, a likely command mismatch in the guide prose may confuse users.
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟡 NEEDS ATTENTION
This PR correctly identifies the three changed areas:
- Vendored YAML files (): Synced from upstream — not reviewed per project policy.
- Release notes (): Well-structured, clear, and accurate.
- Backstage guide (): The command format fix is correct. One minor clarity gap noted inline.
|
|
||
| Monitor the build progress: | ||
| Monitor the build progress using the customization ID from the create output. | ||
| To look up the ID, run: |
There was a problem hiding this comment.
[MEDIUM] Guide doesn't specify which field from customization list output to use as the customization ID
The new text says "Monitor the build progress using the customization ID from the create output" and then offers dhictl customization list --org YOUR_ORG as a lookup alternative. However, it doesn't tell readers which field in the list output to copy as <customization-id>.
The primary path (get the ID from the create output) is clear, but users who need to look it up via customization list may not know whether to use an id, name, or other column. Consider adding a brief note like "use the id value from the output" to remove the ambiguity.
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🔴 CRITICAL
This PR edits vendored CLI reference YAML files (data/cli/dhi/) that must not be modified directly in the docs repo per AGENTS.md. See inline comment for details.
| usage: docker dhi customization build get <repository> <name> <build-id> | ||
| usage: docker dhi customization build get <customization-id> <build-id> | ||
| pname: docker dhi customization build | ||
| plink: docker_dhi_customization_build.yaml |
There was a problem hiding this comment.
[HIGH] Vendored/generated files edited directly in the docs repo
Per AGENTS.md, all YAML files under data/cli/ are vendored from upstream repos and must not be edited here:
Content in
_vendor/and CLI reference data indata/cli/are vendored from upstream repos. Do not edit any of these files — changes must go to the source repository.
This PR directly modifies:
data/cli/dhi/docker_dhi_customization_build_get.yamldata/cli/dhi/docker_dhi_customization_build_list.yamldata/cli/dhi/docker_dhi_customization_build_logs.yaml
These changes need to be made in the upstream source repo (the DHI CLI source) and synced back here via the vendoring/sync process, rather than edited in place in the docs repo.
3 participants
Description
Synced DHI CLI docs:
Backstage guide — Fixed a stale customization build list example in the dhictl CLI tab that still used the old two-argument format; updated to
<customization-id>with a note on how to retrieve it.Related issues or tickets
Reviews