open-telemetry/opentelemetry-ruby-contrib

Improve configuration documentation

开放

#876 创建于 2024年2月20日

在 GitHub 查看贡献者指南
 (1 条评论) (0 个反应) (0 位负责人)Ruby (252 个派生)auto 404
documentationhelp wantedkeep

仓库指标

星标
 (135 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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

贡献者指南

研究方向
研究如何从源代码中提取配置选项并自动生成 Markdown 文档。查看现有工具如 YARD 或自定义脚本。
技术栈
ruby
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
RubyGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70