grafana/loki

Docs feedback: /docs/sources/logql/_index.md

Open

#10,149 opened on Aug 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

The issue with this top level doc page is it gets super sciency with "literals", "scalars", "vectors" , order of operations, vector matching, etc.

Needs to be abit more novice friendly for the most common reader so as not to scare them off. And then have advanced topics as sub topics for the power users.

Focus on basic log search commands and then provide some basic examples such as:

basic search commands to get you started

  • {label=value} |= error
  • {label=value} | logfmt | field=value

Contributor guide

Research direction
The issue requests reorganizing the top level LogQL documentation page at /docs/sources/logql/ index.md to be more novice friendly. Currently, the page dives into advanced concepts like literals, scalars, and vectors. The goal is to restructure it with beginner oriented content, focusing on basic log search commands (e.g., {label=value} |= error) and then moving advanced topics to subpages. Since the issue is assigned, any new contributor should check with the assignee before starting work. Consider reviewing the current file and existing subpages to plan a new structure.
Tech stack
go
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-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
basic knowledge of LogQLunderstanding of documentation structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40