grafana/loki

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

Open

#10,149 opened on 2023年8月2日

GitHub で見る
 (0 comments) (0 reactions) (1 assignee)Go (28,187 stars) (3,997 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.