Skip to content

Conversation

@dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Oct 10, 2023

Removes registry documentation from docs.docker.com

Canonical location for registry/distribution docs is now:

https://distribution.github.io/distribution/

Signed-off-by: David Karlsson [email protected]

Stub preview: /registry/

@netlify
Copy link

netlify bot commented Oct 10, 2023

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 98c38b6
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6530d917ddec630007c1511e
😎 Deploy Preview https://deploy-preview-18390--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@dvdksn dvdksn marked this pull request as ready for review October 10, 2023 15:41
@milosgajdos
Copy link
Contributor

PTAL @thaJeztah

@milosgajdos
Copy link
Contributor

When I click on the previews for storage drivers I get 404 @dvdksn https://deploy-preview-18390--docsdocker.netlify.app/registry/storage-drivers/

@dvdksn
Copy link
Contributor Author

dvdksn commented Oct 11, 2023

@milosgajdos where did you find a link to the storage-drivers page? I thought I'd removed them all

The redirects I added in 5ab929b should point you to the markdown files in distribution/distribution, but might be that those redirects only work in prod, on docs.docker.com

@milosgajdos
Copy link
Contributor

but might be that those redirects only work in prod, on docs.docker.com

Hmm, ok, strange, because they reference full URLs 🤔

@dvdksn
Copy link
Contributor Author

dvdksn commented Oct 11, 2023

@milosgajdos where are you seeing this link?

@milosgajdos
Copy link
Contributor

@dvdksn
Copy link
Contributor Author

dvdksn commented Oct 11, 2023

@milosgajdos ah yeah the search index is from production, but we strip the base url prefix from the search results. Those search results will go away once we reindex the site in prod.

- /go/filter/

# Registry
"https://github.com/distribution/distribution/blob/main/docs/index.md":
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we use permalinks for these (tag or release branch)?

As these are transitional redirects (we stopped publishing these parts of the docs), we probably don't want to continue maintaining the links, and if (some of) these may be removed or may move in upstream, we could get those redirects to be broken otherwise.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As an alternative, we could create a stub/landing page that describes where docs can be found, and redirect all of these to that page.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we are working on getting GH pages docs sorted in upstream and will point these docs to those when done

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, mostly considering that "how to run <some project in the container ecosystem> is somewhat out of scope for our docs, so even with those in place, we should reduce maintenance on our side (and could just point to the upstream github repo)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR for publishing registry docs standalone: distribution/distribution#4101

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed these redirects and added a stub page at /registry/

@dvdksn dvdksn force-pushed the remove-registry branch 2 times, most recently from f635676 to 641625c Compare October 16, 2023 20:09
@dvdksn dvdksn requested a review from a team October 17, 2023 08:49
aevesdocker
aevesdocker previously approved these changes Oct 17, 2023
Removes most of the registry docs, keeping only:

- How to set up a Docker Hub mirror

The canonical location for registry/distribution docs from now on is:

https://distribution.github.io/distribution/

Signed-off-by: David Karlsson <[email protected]>
@dvdksn dvdksn merged commit 5cdff48 into docker:main Oct 19, 2023
@craig-osterhout craig-osterhout mentioned this pull request Apr 25, 2025
3 tasks
craig-osterhout added a commit that referenced this pull request May 23, 2025
<!--Delete sections as needed -->

## Description

Re-add registry reference from point in time of deletion at
#18390, not upstream.


https://deploy-preview-22497--docsdocker.netlify.app/reference/api/registry/latest/

https://deploy-preview-22497--docsdocker.netlify.app/reference/api/registry/auth/

## Related issues or tickets

ENGDOCS-2577

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: Craig <[email protected]>
Co-authored-by: sheltongraves <[email protected]>
Co-authored-by: Sarah Sanders <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants