dhi: refresh mirror & customize#24616
Open
craig-osterhout wants to merge 3 commits intodocker:mainfrom
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 |
Contributor
Author
|
/review |
![docker-agent[bot]](https://avatars.githubusercontent.com/in/2787757?s=60&v=4){kind=small}
Contributor
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.
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
1 participant
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
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.
Previews
Related issues or tickets
ENGDOCS-3222
ENGDOCS-3224
Reviews