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