open-telemetry/opentelemetry-ruby-contrib

Improve configuration documentation

Offen

#876 geöffnet am 20.02.2024

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Ruby (252 Forks)auto 404
documentationhelp wantedkeep

Repository-Metriken

Stars
 (135 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuchen Sie, wie Sie Konfigurationsoptionen aus dem Quellcode extrahieren und automatisch Markdown Dokumentation generieren können. Schauen Sie sich vorhandene Tools wie YARD oder benutzerdefinierte Skripte an.
Tech Stack
ruby
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
RubyGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70