docs icon indicating copy to clipboard operation
docs copied to clipboard

Add tookit doc

Open roidelapluie opened this issue 4 years ago • 4 comments

WIP

Signed-off-by: Julien Pivotto [email protected]

roidelapluie avatar Dec 21 '20 15:12 roidelapluie

Hm, I'm not sure it's good idea adding yet another top-level menu item, we already have too many. Best practice is to limit the number of menu items per level to 7, to not confuse people too much. The exporter toolkit is only relevant for a very small number of people using our docs.

This is the end user documentation, so the TLS config that will be used by all the exporters and Prometheus / AM / Pushgateway. it is not developers doc.

roidelapluie avatar Dec 21 '20 16:12 roidelapluie

I can't make the navbar to work but here is the relevant page for end users https://5fe0c8bd64952c00087ea9b1--prometheus-docs.netlify.app/docs/toolkit/latest/web-configuration/

roidelapluie avatar Dec 21 '20 16:12 roidelapluie

This is the end user documentation, so the TLS config that will be used by all the exporters and Prometheus / AM / Pushgateway. it is not developers doc.

Ah, I wasn't sure what documentation you plan to publish there. Still it seems this fits well in the already existing "Instrumenting" section.

grobie avatar Dec 21 '20 16:12 grobie

Currently where we have duplicated functionality (i.e. http_config) we duplicate the docs in each place in Prometheus, AM, and blackbox where it occurs.

brian-brazil avatar Dec 21 '20 17:12 brian-brazil