grafana/loki

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

Open

#10,391 opened on Aug 29, 2023

View on GitHub
 (0 comments) (1 reaction) (1 assignee)Go (3,997 forks)batch import
help wantedtype/docs

Repository metrics

Stars
 (28,187 stars)
PR merge metrics
 (Avg merge 7d 10h) (312 merged PRs in 30d)

Description

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!!

Contributor guide

Research direction
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.
Tech stack
go
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
basic understanding of Lokifamiliarity with configuration files
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60