dhi: refresh mirror & customize#24616
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
/review |
|
/review |
![docker-agent[bot]](https://avatars.githubusercontent.com/in/2787757?s=60&v=4){kind=small}
There was a problem hiding this comment.
Assessment: 🟡 NEEDS ATTENTION
This PR reorganizes DHI documentation by removing the manage.md page and consolidating management workflows into tabs. The changes are well-structured, but there are two documentation clarity issues that should be addressed:
- Undefined environment variables: CLI examples use
$OATand$DOCKER_ORGwithout showing how to set them - Conflicting OAT guidance: The documentation states OATs work for ORAS but not for
docker dhicommands, but this distinction isn't clearly explained
Both issues could confuse users trying to follow the instructions.
|
/review |
<!--Delete sections as needed --> ## Description - Merged the use in k8 topic into the general use topic. - Removed the generic dhi differences table and just xref'd to the migrations topic that also has it. - Simplified the pull & run section down to just explaining the different registries. - Added how to use els variants and removed that standalone topic. - Replaced dev multi-stage example with an xref to the migration topics - Added DD auth for k8 example for local dev ## Related issues or tickets ENGDOCS-3222 ENGDOCS-3226 #24616 as it may cause conflicts. ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Editorial review --------- Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
There was a problem hiding this comment.
Assessment: 🟡 NEEDS ATTENTION
Found 1 issue in the changed code that should be addressed.
Note: This PR correctly fixes the CLI command syntax in customize.md (moving --org flag to after positional arguments), which aligns with the CLI reference specifications. Good work on that fix!
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
craig-osterhout
force-pushed
the
engdocs-3222-2
branch
from
5e3eadf to
29df018
Compare
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
|
/review |
|
Manually cancelled review as it was already over 35 minutes. Trying again. |
|
/review |
1 participant
Description
Refreshing and reducing left nav sprawl.
Removed management topic. It's not a standalone use-case. The use-case is managing mirrored and customized repos, so moved the info into those topics to reduce left nav sprawl.
For Mirror and Customize:
Moved the how to use an oat with oras out of the mirror topic and into the use topic in the ci/cd section. OATs can't be used to mirror. Reframed the example to be about oras rather than oat based on the requirement. xref'd to the oat topic for creation steps.
Moved webhook section in Mirror from Hub section to third-party mirror section.
In Mirror, changed wording from "mirror to hub" to "mirror to your organization" to be more specific.
Added warning for examples using credentials in CLI
Previews
Related issues or tickets
ENGDOCS-3222
ENGDOCS-3224
Reviews