grafana/loki

Docs feedback: /storage/_index.md

Open

#5,299 opened on Feb 2, 2022

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

Description

Where can we find api docs and schemas? It is totally unclear how to configure all the storage backends. Some examples exist but no reference docs, and no pointers as to where to find it upstream

Contributor guide

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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of Loki architectureFamiliarity with Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests more explicit documentation for configuring storage backends in Loki. The specific file is /storage/ index.md. The contributor should investigate the official APIs for each supported storage backend (e.g., S3, GCS) and add links and configuration references. Existing examples in the documentation should be reviewed for consistency. There are 4 comments that may provide additional context on what the reporter expects.