On Sat, 14 Mar 2020 at 12:05, Julien Pivotto <[email protected]> wrote:
> Richard, > > That is a great question. The Prometheus documentation looks more like a > man page than modern documentation. > Given how complex it is, it would be nice to see how we can improve the > documentation about vector matching, range vectors, instant vectors, and or > without group_right. > > I am thinking, e g., about adding simple but coherent diagrams/images that > would help newcomers to grasp those principles. Having updated relevant > examples to go with(in) the figures would help, too. > The current docs are primarily reference docs, trying to also make a given page serve an additional goal will only make it less usable for everyone. https://www.divio.com/blog/documentation/ has a good rundown on it. I've seen this in the past where attempting to make the reference docs more usable to newcomers didn't really help new users due to all the detail and precision they still have to contain, while also making it harder for experienced users to now do a quick reference lookup. Any new type of doc should go on different pages, such as we have with the guides. Brian > > > Thanks > > > ----- Original Message ----- > From: Richard Hartmann <[email protected]> > To: [email protected] > Sent: Thu, 12 Mar 2020 12:04:18 +0100 (CET) > Subject: [prometheus-users] Prometheus docs > > Dear all, > > if we as Prometheus team were to try and improve our docs, what would > be the most pressing areas in your opinion? > > > Best, > Richard > > -- > You received this message because you are subscribed to the Google Groups > "Prometheus Users" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/prometheus-users/CAD77%2BgSPXH2g_pEgfExxmK5CyZPRc6E251e73_JrCBtbrhWZNA%40mail.gmail.com > . > > -- > You received this message because you are subscribed to the Google Groups > "Prometheus Users" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/prometheus-users/628864931.2762.1584187524823.JavaMail.zimbra%40inuits.eu > . > -- Brian Brazil www.robustperception.io -- You received this message because you are subscribed to the Google Groups "Prometheus Users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/prometheus-users/CAHJKeLp2Liuc3RvSha86ruDwhC22W_eWAQNmm-HT7726OG9EQQ%40mail.gmail.com.
