Docker Hub overview is a stale copy of README and links to a 404
@majinghe is already working on this.
Since Sep 18, 2026.
- Dominant language
- Rust
- Stars
- 33.3k
- Forks
- 1.5k
- Avg merge
- 2h 57m
- Merged PRs (30d)
- 962
Description
Describe the bug
The overview shown on https://hub.docker.com/r/rustfs/rustfs is an old snapshot of README.md. It still links to https://docs.rustfs.com/introduction.html, which now returns 404.
The current README.md no longer contains that URL — it points to https://docs.rustfs.com/en/installation instead.
To Reproduce
- Open https://hub.docker.com/r/rustfs/rustfs
- Follow the documentation link in the overview
- It lands on
https://docs.rustfs.com/introduction.html→ 404
Or from the API:
$ curl -s https://hub.docker.com/v2/repositories/rustfs/rustfs/ \
| jq -r .full_description | grep -o 'https://docs\.rustfs\.com[^ )]*' | sort -u
https://docs.rustfs.com
https://docs.rustfs.com/
https://docs.rustfs.com/introduction.html
$ curl -s -o /dev/null -w '%{http_code}\n' -L https://docs.rustfs.com/introduction.html
404
Expected behavior
The Docker Hub overview reflects the current README.md, and its documentation links resolve.
Additional context
The two have drifted a long way apart:
| size | |
|---|---|
Docker Hub full_description |
8,434 chars |
README.md on main |
22,879 chars |
Docker Hub's overview is not updated by docker push — it is a separate full_description field, written through the web UI or PATCH /v2/repositories/<namespace>/<repo>/. I could not find anything in this repository that writes it: .github/workflows/docker.yml uses docker/login-action and docker/build-push-action, neither of which touches the description, and searching the repo for dockerhub-description, full_description and hub.docker.com/v2 returns nothing. So it appears to be maintained by hand, which would explain the drift.
If keeping it in sync automatically sounds useful, a step like this in docker.yml would do it, and it needs no new secrets — DOCKERHUB_USERNAME and DOCKERHUB_TOKEN are already used by the Docker Hub login step:
- name: Sync Docker Hub description
uses: peter-evans/dockerhub-description@v5.0.0
with:
username: ${{ env.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
repository: rustfs/rustfs
readme-filepath: ./README.md
One caveat if you go that way: Docker Hub caps full_description at 25,000 characters, and README.md is at 22,879 today, so there is not much headroom left.
Happy to open a PR for this if it would be welcome.
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.
Assessment
This issue has not been assessed yet.