grafana/loki

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

Open

Aperta il 2 ago 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (1 assegnatario)Go (28.187 star) (3997 fork)batch import
help wantedtype/docs

Descrizione

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

Guida contributor

Tech stack
go
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
blocked
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
basic knowledge of LogQLunderstanding of documentation structure
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40
Direzione di ricerca
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.