Update Prometheus Readme on docker hub

31 views
Skip to first unread message

Julien Pivotto

unread,
Feb 2, 2022, 11:01:48 AM2/2/22
to prometheus-developers

Hello,

Someone pointed out on twitter that our Docker Hub readme was not
useful to run Prometheus in Docker. They also suggested a snippet from
our documentation to update it.
https://twitter.com/phil_eaton/status/1488895298239877128

After analyzing the claim, the README of the docker image was very
outdated. I have therefore applied the user's advice.

We can think further how we can improve this, but I think it was not
reasonable to have a X years old readme on the docker hub.

This is the new page:

https://hub.docker.com/r/prom/prometheus

Regards,


--
Julien Pivotto
@roidelapluie

Ben Kochie

unread,
Feb 2, 2022, 1:27:19 PM2/2/22
to prometheus-developers
I looked into this a while back and didn't find a good API / tool to automatically push updates.

Maybe things have improved since I last tried.

--
You received this message because you are subscribed to the Google Groups "Prometheus Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to prometheus-devel...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/prometheus-developers/20220202160143.GA669695%40hydrogen.

Matthias Rampke

unread,
Feb 4, 2022, 8:13:07 AM2/4/22
to Ben Kochie, prometheus-developers
I propose that we cut most of it, only keep a short paragraph about what Prometheus is, and link to prometheus.io/docs and/or the README for details? That way we only need to update it when things fundamentally change. I don't think people come to Docker Hub to read extended documentation, and following a link is not a burden in that case.

/MR

Julien Pivotto

unread,
Feb 4, 2022, 8:19:59 AM2/4/22
to Matthias Rampke, Ben Kochie, prometheus-developers
On 04 Feb 13:12, Matthias Rampke wrote:
> I propose that we cut most of it, only keep a short paragraph about what
> Prometheus is, and link to prometheus.io/docs and/or the README for
> details? That way we only need to update it when things fundamentally
> change. I don't think people come to Docker Hub to read extended
> documentation, and following a link is not a burden in that case.


That's mostly what I did, did you check the last version?
> > https://groups.google.com/d/msgid/prometheus-developers/CABbyFmr_0dg7kP-omQVrzeLnrQFQ%3DuoyCZBTEb_qqU6g8%2BDZkA%40mail.gmail.com
> > <https://groups.google.com/d/msgid/prometheus-developers/CABbyFmr_0dg7kP-omQVrzeLnrQFQ%3DuoyCZBTEb_qqU6g8%2BDZkA%40mail.gmail.com?utm_medium=email&utm_source=footer>
> > .
> >
>
> --
> You received this message because you are subscribed to the Google Groups "Prometheus Developers" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to prometheus-devel...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/prometheus-developers/CAMV%3D_gacDJghire3uppkA6FughHi2ax-UJSaDC1R_8sbO%3D5Kyw%40mail.gmail.com.

--
Julien Pivotto
@roidelapluie

Matthias Rampke

unread,
Feb 4, 2022, 8:42:00 AM2/4/22
to Matthias Rampke, Ben Kochie, prometheus-developers
Ah, I didn't realize. I would have kept even less information but if this is not too much to keep up to date, I'm happy! Let's see how things develop :)

/MR
Reply all
Reply to author
Forward
0 new messages