search

docker / roadmap

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

Add support for reStructuredText Readme #462

Open Dsantra92 opened 1 year ago

Dsantra92 commented 1 year ago

Tell us about your request Currently, DockerHub cannot render rst files correctly on the DockerHub web, example: https://hub.docker.com/r/unifyai/ivy. We use rst for our sphinx docs and rst works well with most websites like PyPI. So, adding support for rst should be very helpful. This issue is a copy of https://github.com/docker/hub-feedback/issues/621 because it was in the bug reporting repository (7 years ago).

Which service(s) is this request for? This service request is for the DockerHub web interface.

Tell us about the problem you're trying to solve. What are you trying to do, and why is it hard? On every build, docker scrapes the readme file from the repository and uses it as the landing page of the repository in the DockerHub. While readme update on every push is a lucrative feature the rst rendering makes an unappealing first impression for any new user.

Are you currently working around the issue? None

milosgajdos commented 1 year ago

@Dsantra92 We don't have any plans to introduce support for rst files anytime soon.