Skip to content

registry: prune registry docs - #18390

Merged
dvdksn merged 1 commit into
docker:mainfrom
dvdksn:remove-registry
Oct 19, 2023
Merged

registry: prune registry docs#18390
dvdksn merged 1 commit into
docker:mainfrom
dvdksn:remove-registry

Conversation

@dvdksn

@dvdksndvdksn commented Oct 10, 2023

Copy link
Copy Markdown
Contributor

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 35727626+dvdksn@users.noreply.github.com

Stub preview: /registry/

@netlify

netlifyBot commented Oct 10, 2023

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

NameLink
🔨 Latest commit98c38b6
🔍 Latest deploy loghttps://app.netlify.com/sites/docsdocker/deploys/6530d917ddec630007c1511e
😎 Deploy Previewhttps://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.

@milosgajdos

Copy link
Copy Markdown
Contributor

PTAL @thaJeztah

@milosgajdos

Copy link
Copy Markdown
Contributor

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

@dvdksn

Copy link
Copy Markdown
ContributorAuthor

@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
Copy Markdown
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
Copy Markdown
ContributorAuthor

@milosgajdos where are you seeing this link?

@milosgajdos

Copy link
Copy Markdown
Contributor

I go here https://deploy-preview-18390--docsdocker.netlify.app/ then I search for some registry stuff

@dvdksn

Copy link
Copy Markdown
ContributorAuthor

@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.

Comment threaddata/redirects.yml Outdated
- /go/filter/

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

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
ContributorAuthor

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
Copy Markdown
ContributorAuthor

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
dvdksnforce-pushed the remove-registry branch 2 times, most recently from f635676 to 641625cCompareOctober 16, 2023 20:09
@dvdksn
dvdksn requested a review from a teamOctober 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 <35727626+dvdksn@users.noreply.github.com>
@dvdksn
dvdksn merged commit 5cdff48 into docker:mainOct 19, 2023
@craig-osterhoutcraig-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 <craig.osterhout@docker.com>
Co-authored-by: sheltongraves <148902861+sheltongraves@users.noreply.github.com>
Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
Sign up for freeto 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

@dvdksn@milosgajdos@thaJeztah@aevesdocker