grafana/mimir

Docs: Generate Mimirtool documentation similarly to the config file documentation

Open

#4.291 aberto em 24 de fev. de 2023

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

Métricas do repositório

Stars
 (5.181 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Examine o processo existente de geração de documentação de arquivos de configuração no repositório Mimir, provavelmente usando uma ferramenta como `doc generator` ou `go generate`, e então replique uma abordagem semelhante para as flags da CLI do mimirtool definidas em `pkg/mimirtool/commands`.
Pilha de tecnologia
go
Domain
backenddeveloper experience
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Go
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70