Suggestion: Loki (or really all LGTM) Docs

What I have found hardest about using all the awesome LGTM products is the difficulty in mapping versions of the various solutions to relevant/pertinent documentation in the docs website.

Specifically, it is extremely hard to tell whether advice on various pages still applies when a newer version of Loki comes out. For example with the release of tsdb it is not clear whether advice across the docs related to BoltDB continues to be applicable, or whether some parts of it have been superseded.

This is not an argument for deleting docs; obviously people are still using BoltDB, and need help as well, but with the rapid velocity of the improvement of your products, it does mean that sifting the documentation for those portions that are relevant to a specific setup of a version is harder than it could be.

One simple suggestion I’d like to make is to publish the “last change date” from the Git history onto the rendered pages of your documentation. That way it’s at least easier to determine whether a page has been recently updated to reflect newer features, or if it hasn’t been touched in a while.

It’d also be awesome to have more modular config documentation, because the one long single page spelling out all the settings across all the services makes it really hard to figure out which settings might be consumed by a Read or Write or Backend target as well.

In any case, thanks for the awesome software, and hopefully something here will spark some ideas on how to make it easier for newbies or less routine use-cases to figure out how to make this software work for them!

1 Like