-
Notifications
You must be signed in to change notification settings - Fork 7.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
registry: prune registry docs #18390
Conversation
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
PTAL @thaJeztah |
When I click on the previews for storage drivers I get |
@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 |
Hmm, ok, strange, because they reference full URLs 🤔 |
@milosgajdos where are you seeing this link? |
I go here https://deploy-preview-18390--docsdocker.netlify.app/ then I search for some registry stuff |
@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. |
data/redirects.yml
Outdated
@@ -619,3 +619,55 @@ | |||
# CLI backlinks | |||
"/config/filter/": | |||
- /go/filter/ | |||
|
|||
# Registry | |||
"https://github.com/distribution/distribution/blob/main/docs/index.md": |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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)
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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/
f635676
to
641625c
Compare
641625c
to
cd3f421
Compare
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]>
cd3f421
to
98c38b6
Compare
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/