open-telemetry/opentelemetry-ruby-contrib

Improve configuration documentation

Open

#876 opened on Feb 20, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Ruby (252 forks)auto 404
documentationhelp wantedkeep

Repository metrics

Stars
 (135 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Investigate how to extract configuration options from the source code and generate markdown documentation automatically. Look at existing tools like YARD or custom scripts.
Tech stack
ruby
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RubyGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70