hub: add base url to api paths
Description
Display the base url specifically for Hub API and Registry API docs.
Is this enough, or do we also need to write something about it in the description at the top?
Related issues or tickets
ENGDOCS-2748
Reviews
- [ ] Editorial review
Deploy Preview for docsdocker ready!
| Name | Link |
|---|---|
| Latest commit | 240f443263f3d4250eec187244bb37d547f65070 |
| Latest deploy log | https://app.netlify.com/projects/docsdocker/deploys/68531ef1aab3d100081b3a9c |
| Deploy Preview | https://deploy-preview-22870--docsdocker.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.
Thanks!
Did a quick check if they used the correct URL (especially the registry, as it uses registry-1.docker.io, not hub.docker.com), but looks like it does;
I have not checked all of them though, and perhaps @jcarter3 could help double-check.
Is this enough, or do we also need to write something about it in the description at the top?
I'm somewhat tempted to say that it would still be good to have a page somewhere that outlines the domains; specifically because we've historically not been good at documenting them, and in some case have introduced alternative domains that should not be used / not be considered the canonical domain. Having something at the top for each of these API docs won't hurt either.
I know many users have been confused about the domain to use, as many have assumed that hub.docker.com is the domain to use both for the WebUI and APIs related to Docker Hub (which also has been a cause of issues when they want to block access to docker hub registry 😅)
I don't have the full list of the correct ones though, but perhaps @jcarter3 (or someone else closer to Docker Hub and related services) can assist with that as well.
Yup, looks good to me!