Docker documentation seems broken

freeCodeCamp / devdocs

API Documentation Browser

https://devdocs.io

Mozilla Public License 2.0

35.1k stars 2.34k forks source link

Docker documentation seems broken #796

Open MichaelAquilina opened 6 years ago

MichaelAquilina commented 6 years ago

For all versions of docker, I simply get a small bar showing the license and a link to the docker documentation (docs.docker.com)

j-f1 commented 6 years ago

That’s just the homepage — see http://devdocs.io/docker~17/compose/compose-file/compose-versioning/index for a working page.

MichaelAquilina commented 6 years ago

oh right - Searching works correctly in fact. It's a bit confusing the first time you see it though. Would there be a better alternative for a homepage considering most of the other documentation packages contain detailed homepages?

thewheat commented 2 years ago

Seems for the root page we currently hardcode to just return a header thus why it's blank

https://github.com/freeCodeCamp/devdocs/blob/4c70959ee9bcf58b649ed4247bed0caab0418462/lib/docs/filters/docker/clean_html.rb#L5-L8

Possible solutions:

scrape the homepage and link out to the appropriate docs
redirect the root to to another page e.g. https://docs.docker.com/get-started/ and use that instead