open-telemetry/opentelemetry-ruby-contrib

Improve configuration documentation

Aberta

#876 aberto em 20 de fev. de 2024

Ver no GitHubGuia do colaborador
 (1 comentário) (0 reação) (0 responsável)Ruby (252 forks)auto 404
documentationhelp wantedkeep

Métricas do repositório

Stars
 (135 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

YARD/RDoc doesn't provide a great way for us to add documentation for our configuration options

Ideas:

  • Automate addition of config documentation to READMEs for individual gems
  • Automate a section in instrumentation-all that lists the config options for all the gems that get installed

See #825 as one example for README-style documentation

Guia do colaborador

Direção de pesquisa
Investigue como extrair opções de configuração do código fonte e gerar documentação markdown automaticamente. Veja ferramentas existentes como YARD ou scripts personalizados.
Pilha de tecnologia
ruby
Domain
documentation
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.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
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
RubyGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70