jaegertracing/jaeger

[v2] Auto-generate configuration documentation

Open

#6,186 建立於 2024年11月9日

在 GitHub 查看
 (11 留言) (0 反應) (0 負責人)Go (18,974 star) (2,326 fork)batch import
area/otelgood first issuehelp wantedv2

描述

We want to employ a schema-first approach to configuration:

  • define a schema for configuration structures first
  • use code generator to create types in Go
  • automatically generate documentation from the schema

(30-Jan-2026) The OTEL Collector is also moving in this direction, with the first phase available where Go structs can be parsed to generate schema in YAML (https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/45732)

References:

Tasks:

  • Try running the schemagen script on some of Jaeger's internal collector extensions to see if it can generate sensible schemas.
  • Auto-generate documentation from those schemas (follow OTEL example)

貢獻者指南

技術棧
go
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
active
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Go programmingBasic understanding of configuration schemasFamiliarity with OTEL collector
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
First, try running the schemagen script from the OTEL collector contrib repository (see https://github.com/open telemetry/opentelemetry collector contrib/blob/main/cmd/schemagen/README.md) on one of Jaeger's internal collector extensions to see if it produces sensible schemas. Then, based on the output, implement auto generation of configuration documentation following the approach used in the OTEL project, possibly referencing the configschema docs generator. Consult the linked PRs and issues for patterns.