grafana/loki

Docs feedback: /docs/sources/configuration/_index.md - Loki docs need a new page about runtime config file(s)

Open

#10,391 建立於 2023年8月29日

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

描述

The Loki docs lack a page to explain the concept of a "runtime config file", similar to this doc page for Mimir: https://grafana.com/docs/mimir/latest/configure/about-runtime-configuration

I believe the same concept exists for Loki, because I see this: https://grafana.com/docs/loki/latest/configuration/#runtime_config

But we need much more detail in the docs, like:

  • explain the concept of a runtime config file
  • how to use it
  • and importantly: what can (and can't) be configured in the runtime config file(s)

It probably needs its own separate doc page, as in the Mimir docs.

I expect we would need to get someone from Loki Engineering to write the bulk of this doc page, in order to get all the correct details.

Thanks!!

貢獻者指南

技術棧
go
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
needs maintainer response
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic understanding of Lokifamiliarity with configuration files
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Review the existing Mimir runtime configuration documentation at https://grafana.com/docs/mimir/latest/configure/about runtime configuration for structure and content. Also examine the current Loki configuration page at https://grafana.com/docs/loki/latest/configuration/#runtime config to understand the existing references. Consult with Loki engineering team members to gather accurate details about what can and cannot be configured in runtime config files, as the bulk of the technical content will come from them.
Docs feedback: /docs/sources/configuration/_index.md - Loki docs need a new page about runtime config file(s) · grafana/loki#10391 | Good First Issue