> I think the "onboarding" documentation should *not* be tied to
> Prometheus versions and should be managed independently from the
> Prometheus configuration, in the actual "github.com/prometheus/docs"
> repository.

Agree with keeping evergreen documentation outside of the release cycle
of Prometheus itself. I think that the cases where you want to refer to
something version-specific in that style of documentation will be the
exception rather than the rule, and can be handled with a temporary
"This is available from Prometheus version X" notice.

I'm not sure if it's helpful in terms of clarifying different styles of
docs that might be worth focusing on, but a coworker at my last job
introduced me to this framing of different types of docs:

https://documentation.divio.com/

which I found quite useful.

I think there's still huge value in having reference docs, but of all
the styles they're the most useful when you already know and understand
most of what you're doing, and just need to look at details for a few
specific features.

-- 
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/CAN-H%2Byb5%3Dot_w9Gs%3DTRooTPeR35cXfN8aHtSKerszTxLhv%3Ds5Q%40mail.gmail.com.

Reply via email to