open-telemetry / open-telemetry/opentelemetry-ruby-contrib
Improve configuration documentation
Open
Nobody has claimed this yet.
documentation
help wanted
keep
- Dominant language
- Ruby
- Stars
- 137
- Forks
- 258
- Avg merge
- 3d 17h
- Merged PRs (30d)
- 30
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-allthat lists the config options for all the gems that get installed
See #825 as one example for README-style documentation
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with issue #825 and the existing README-style documentation for an individual gem. Review how YARD/RDoc currently represent configuration options and how the instrumentation-all section is maintained. Done means agreeing on an approach and documenting configuration options consistently in the relevant gem READMEs and/or the aggregate section.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100