Conversation
Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
nanoc.yaml
Outdated
| items_root: /docs/toolkit/ | ||
| config: | ||
| entrypoint: /introduction/ | ||
| repository_url: https://github.com/roidelapluie/exporter-toolkit |
There was a problem hiding this comment.
This doesn't seem right
There was a problem hiding this comment.
This is a draft, I am working on my repo before branching right the tookit repo.
Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
grobie
left a comment
grobie
left a comment
There was a problem hiding this comment.
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.
I'd suggest mounting the docs below Instrumenting instead. Not sure whether that requires some changes to the navigation code to allow repodocs on that level.
content/_redirects
Outdated
| /docs/instrumenting/ /docs/instrumenting/clientlibs/ 302! | ||
| /docs/operating/ /docs/operating/security/ 302! | ||
| /docs/alerting/ /docs/alerting/latest/overview/ 302! | ||
| /docs/tookit/ /docs/toolkit/latest/introduction/ 302! |
There was a problem hiding this comment.
| /docs/tookit/ /docs/toolkit/latest/introduction/ 302! | |
| /docs/toolkit/ /docs/toolkit/latest/introduction/ 302! |
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. |
Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
|
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/ |
Ah, I wasn't sure what documentation you plan to publish there. Still it seems this fits well in the already existing "Instrumenting" section. |
|
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. |
|
Hello from the bug scrub! |
4 participants
WIP
Signed-off-by: Julien Pivotto roidelapluie@inuits.eu