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.