grafana/loki

[Docs] Prometheus references, either remove or link out to Prometheus docs

Open

#9,369 opened on May 2, 2023

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Go (3,997 forks)batch import
help wantedtype/docs

Repository metrics

Stars
 (28,187 stars)
PR merge metrics
 (Avg merge 7d 10h) (312 merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe.

Loki is "Like Prometheus, but for logs!"

This assumes that users are already familiar with Prometheus. The project has grown in popularity to the point where we are attracting users who are NOT familiar with Prometheus.

Describe the solution you'd like

Search the documentation for Prometheus references and either:

  • Remove the reference and describe how Loki works.
  • OR
  • Link out to the relevant Prometheus documentation.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Prometheus references are confusing and frustrating to new Loki users, since our current documentation make it look like you need to learn Prometheus before you can use Loki.

### Tasks
- [ ] [Storage Docs](https://grafana.com/docs/loki/next/storage/)  "Unlike other logging systems, Grafana Loki is built around the idea of only indexing metadata about your logs: labels (just like Prometheus labels)"  Link to https://prometheus.io/docs/practices/naming/#labels  ?

Contributor guide

Research direction
Search the Loki documentation for any references to Prometheus, particularly in storage docs as listed in the issue. For each reference, either remove it or link to the relevant Prometheus documentation. The issue provides an example of linking to Prometheus naming conventions. Ensure consistency across all docs.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Loki basicsMarkdown editing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80