open-telemetry/opentelemetry-ruby-contrib

Improve configuration documentation

Aperta

#876 aperta il 20 feb 2024

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Ruby (252 fork)auto 404
documentationhelp wantedkeep

Metriche repository

Star
 (135 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Scopri come estrarre le opzioni di configurazione dal codice sorgente e generare automaticamente la documentazione in markdown. Dai un'occhiata a strumenti esistenti come YARD o script personalizzati.
Tech stack
ruby
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
RubyGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70