Docker Hub README -> GitHub README?
Open
Nobody has claimed this yet.
docs
enhancement
meta
priority: low
- Dominant language
- Shell
- Stars
- 7.4k
- Forks
- 1.9k
- PR merge metrics
- No merged PRs in 30d
Description
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?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the Docker Hub README with the GitHub README and reviewing which content and Markdown features each platform supports. The issue needs a decision about linking, retaining, or automating the Docker Hub content; done means an agreed direction and a defined documentation or automation scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100