search

swagger-api / swagger-ui

Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
https://swagger.io
Apache License 2.0
26.41k stars 8.93k forks source link

Installation (and usage) links broken on Docker Hub #6233

Open idoqo opened 4 years ago

idoqo commented 4 years ago

Q&A (please complete the following information)

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

hkosova commented 3 years ago

It's a Docker Hub issue with how it handles (or rather, does not handle) relative links: https://github.com/docker/hub-feedback/issues/418

ffmit commented 3 years ago

Is there any alternative to get the documentation? The Docker hub issue is open for more than 5 years. As there are 10M pulls of the image, it would be good to have a workaround. I searched the net but found nothing so far.

hkosova commented 3 years ago

@ffmit Swagger UI docs are available on swagger.io https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation/ and in the docs subfolder of this repo: https://github.com/swagger-api/swagger-ui/blob/master/docs/SUMMARY.md