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?
Maintaining the README on the Docker Hub entry has some challenges:
Questions: