Skip to content
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

Documentation mismatched! #3506

Closed
namnx228 opened this issue Oct 4, 2021 · 5 comments
Closed

Documentation mismatched! #3506

namnx228 opened this issue Oct 4, 2021 · 5 comments

Comments

@namnx228
Copy link

namnx228 commented Oct 4, 2021

I notice that the minimumtls field is introduced in the doc: https://github.com/distribution/distribution/blob/main/docs/configuration.md#tls, leading to the general docker document having the same info: https://docs.docker.com/registry/configuration/#tls. However, we have not yet had this configuration in the registry latest release and in the official docker image. Therefore, the doc is now introducing a not-yet-in-place configuration , making a confusion for people following the documentation on https://docs.docker.com/registry/configuration/.

@thaJeztah
Copy link
Member

I suspect this is because the docker documentation uses the release/2.7 release branch as source for the documentation. Under normal ("most") situations, this should match the latest release from that branch (new features generally aren't back ported, only bug fixes, which don't bring user-facing changes), but it looks like #3384 back ported this feature (but has not been released).

/cc @milosgajdos @waynr

@milosgajdos
Copy link
Member

yes, that's very likely the cause of this I'm afraid

@namnx228
Copy link
Author

namnx228 commented Oct 7, 2021

Thanks, @thaJeztah @milosgajdos for explanation. So how should we fix it? Should the docker document points to the latest commitinf the release instead of the branch release/2.7?

@milosgajdos
Copy link
Member

@namnx228 with the latest release out last night https://github.com/distribution/distribution/releases/tag/v3.0.0-alpha.1 I'm inclined to close this issue

Furthermore, the docs are now owned by this GH organization and no longer by Docker Inc. They're available at https://distribution.github.io/distribution/

@thaJeztah
Copy link
Member

Yes, we can close this one; the docker documentation was updated, and no longer copies the docs, but instead links to the distribution documentation at https://distribution.github.io/distribution/

For older versions of the registry, the docs in the github repository can be used, e.g.; for the v2.8.3 release; https://github.com/distribution/distribution/tree/v2.8.3/docs

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

No branches or pull requests

3 participants