grafana/mimir

Docs: Generate Mimirtool documentation similarly to the config file documentation

Open

#4,291 opened on Feb 24, 2023

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Go (808 forks)auto 404
enhancementhelp wantedkeep-alivetoolingtype/docs

Repository metrics

Stars
 (5,181 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your documentation request related to a feature? If so, which one?

This is related to the mimirtool documentation hosted at: https://grafana.com/docs/mimir/latest/operators-guide/tools/mimirtool/

Describe the solution that you’d like or the expected outcome

This document is hand-written and has fallen out of sync with the capabilities of the tool. Most command-line flags are undocumented. If this documentation was generated from the flags defined in cmd/mimirtool's different command files (located in pkg/mimirtool/commands), it would be possible to keep it up to date automatically. This could perhaps be done with a special script called by go generate.

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.