grafana/loki

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

Open

#10.149 geöffnet am 2. Aug. 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Go (28.187 Stars) (3.997 Forks)batch import
help wantedtype/docs

Beschreibung

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

Tech Stack
go
Domain
documentation
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
blocked
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
basic knowledge of LogQLunderstanding of documentation structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
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.