Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Operations > Loki in Grafana has very limited information #8908

Open
matyax opened this issue Mar 27, 2023 · 1 comment
Open

Docs: Operations > Loki in Grafana has very limited information #8908

matyax opened this issue Mar 27, 2023 · 1 comment
Labels
help wanted We would love help on these issues. Please come help us! type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories

Comments

@matyax
Copy link

matyax commented Mar 27, 2023

Describe the bug
When researching the getting started experience with Grafana and Loki, we found that it's not easy to find documentation or links pointing out to how to set up Loki as a data source in Grafana. Currently, the Loki docs have a Loki in Grafana section inside Operations, that compared with Loki data source offers very limited information.

It would be positive to point that section to Loki data source, or at least include a link to it in case the user needs more in-depth information about setting up the data source.

Other nice to haves:

  • Consider if Operations appropriately categorizes this documentation topic. During the research it was unexpected to find the data source configuration under this category.
  • Consider if it can be possible to arrive to this documentation page without being familiar with the "data source" concept, for example, by searching for "grafana loki setup".
  • The docs are missing details for error or success state, how does a successfully configured data source look like.
  • The “Loki in Grafana” page refers to the configuration icon as the “cog” icon, while “Loki data source” calls it “gear” icon.
  • The “Loki data source” page is missing a paragraph explaining the user, once they configured the data source, how to execute their first query.

To Reproduce
See Get Started Overhaul: Loki.

@matyax matyax added type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories area/docs labels Mar 27, 2023
@GrafanaWriter
Copy link
Contributor

great feedback on this topic. @lwandz13 and @JStickler, FYI

@chaudum chaudum removed the area/docs label Jun 15, 2023
@JStickler JStickler added the help wanted We would love help on these issues. Please come help us! label Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted We would love help on these issues. Please come help us! type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

No branches or pull requests

4 participants