search

docker / roadmap

Welcome to the Public Roadmap for All Things Docker! We welcome your ideas.
https://github.com/orgs/docker/projects/51
Creative Commons Zero v1.0 Universal
1.74k stars 257 forks source link

[Docker Hub] Make it possible to link directly to subsections in image description docs #88

Open hairyhenderson opened 4 years ago

hairyhenderson commented 4 years ago

Tell us about your request

I'd like to be able to link to paragraphs in image docs, just like I can in a Markdown file in GitHub.

To point someone directly at the section of the documentation, in GitHub I'd browse to the appropriate spot, hit the 🔗(link) icon, and send them the link. For example: https://github.com/docker-library/docs/tree/master/caddy#adding-custom-caddy-modules

In DockerHub, I'd like to be able to do the same, but currently all I can do is send them https://hub.docker.com/_/caddy?tab=description and ask them to ⌃F and search the page for Adding custom Caddy modules.

Which service(s) is this request for?

DockerHub

Tell us about the problem you're trying to solve. What are you trying to do, and why is it hard?

It's frustrating to send someone the link to a DockerHub page to point them at a piece of documentation, and not be able to send the exact link they need.

Are you currently working around the issue?

Not in any satisfactory way!

Additional context

n/a

tianon commented 4 years ago

For official images at least, a workaround is to link to the GitHub copy of the rendered description instead: https://github.com/docker-library/docs/tree/master/caddy#adding-custom-caddy-modules

(Although I fully agree this isn't a great workaround and should be possible on Hub instead :innocent: :heart: :+1:)

manishtomar commented 4 years ago

The URL should also always default to description instead of ?tab=description. Ideally the query string should be replaced with actual URLs. So https://hub.docker.com/_/caddy -> shows description https://hub.docker.com/_/caddy/reviews -> shows reviews https://hub.docker.com/_/caddy/tags -> shows tags

hairyhenderson commented 4 years ago

The URL should also always default to description instead of ?tab=description

True - sorry if my description was misleading, I wanted to clarify that I'd be sending them to the description tab specifically.

Clicking on the description tab takes you to ?tab=description - the query string seems to not be replaced for any of the other URLs either. Though that's somewhat orthogonal to this issue 😉.

hairyhenderson commented 4 years ago

@pkennedyr any updates on this? (pinging you because you tagged it as docker_hub earlier 😉)

ingshtrom commented 4 years ago

cc @nebuk89