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.

Sign up for GitHub

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

Jump to bottom

Docker Hub README -> GitHub README? #2322

Open

joshtrichards opened this issue Oct 22, 2024 · 0 comments

Labels

docs enhancement meta priority: low

Member

joshtrichards commented Oct 22, 2024

Maintaining the README on the Docker Hub entry has some challenges:

ends up out of date (we update the GitHub README more often than we port over the changes to Docker Hub)
some GitHub markdown conventions are not supported by Docker Hub (e.g. call-outs)
it's more work for us

Questions:

Is it okay for Docker Official Images to replace their Docker Hub contents (beyond the essentials like tags and some basic introductory context/etc) with a link to their GitHub README or other docs?
If so, should we do this?
Or, if we keep it, should we consider automating some of the updating?
And, if we keep it, are the unsupported markdown bits worth keeping on GitHub?

joshtrichards added docs enhancement meta priority: low labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment