swagger-api / swagger-api/swagger-ui

Installation (and usage) links broken on Docker Hub

Open
#6,233 3 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cat: docker cat: documentation type: enhancement
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Q&A (please complete the following information)
  • Browser: [Firefox]
  • Version: [3.29.0]
Describe the bug you're encountering

Probably a minor issue but it confused me at first.

The link to the installation guide (and all other internal links) on Docker hub returns a 404 page e.g https://hub.docker.com/r/swaggerapi/docs/usage/installation.md.
They all work fine on github though. This is probably because the links in the readme were written to match the project folder structure which docker hub doesn't respect, but github does.

Does it make sense to update the readme to use absolute links instead so it doesn't break on docker hub?

To reproduce...

Steps to reproduce the behavior:

  1. Go to https://hub.docker.com/r/swaggerapi/swagger-ui
  2. Click on link in any of the subsections (i.e Usage, Customization, Development)
  3. See error
Expected behavior

Link should point to the right documentation

Screenshots

docker-hub-404

Additional context or thoughts

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repository README and inspect the internal links used in the Usage, Customization, and Development sections. Compare them with the corresponding GitHub documentation paths, update the links so they resolve from Docker Hub, and verify the links from the Swagger UI Docker Hub page.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.