[experiment] Auto-generate documentation for jaeger-v2 configuration structs via AST #6628
Labels
documentation
good first issue
Good for beginners
help wanted
Features that maintainers are willing to accept but do not have cycles to implement
v2
We are still blocked on the main issue #6186 by schema-first efforts in OTEL Collector not progressing. I wonder if we could instead use the Go's AST library to navigate the hierarchy of known config structs and extract the comments and other metadata needed for the docs, and/or config examples.
There are various blog posts showing examples of using AST.
The tool could have just a hardcoded list of starting configuration structs, both from Jaeger and from OTEL code base, e.g.
cmd/jaeger/internal/extension/jaegerquery/config.go
.Rough outline of the milestones:
The text was updated successfully, but these errors were encountered: