open-telemetry/opentelemetry-ruby-contrib

Improve configuration documentation

Ouverte

#876 ouverte le 20 févr. 2024

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)Ruby (252 forks)auto 404
documentationhelp wantedkeep

Métriques du dépôt

Stars
 (135 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Etudiez comment extraire les options de configuration du code source et generer automatiquement une documentation markdown. Regardez les outils existants comme YARD ou les scripts personnalises.
Stack technique
ruby
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
RubyGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70