grafana/loki

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

Open

#10,149 建立於 2023年8月2日

在 GitHub 查看
 (0 留言) (0 反應) (1 負責人)Go (28,187 star) (3,997 fork)batch import
help wantedtype/docs

描述

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

貢獻者指南

技術棧
go
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
blocked
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic knowledge of LogQLunderstanding of documentation structure
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
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.