Open tiffany76 opened 3 months ago
Thanks for raising this issue.
We can (and should) incorporate that data into the otel website. Ideally this data flows into the registry and then we reuse it from there in the documentation.
To do so we need to collaborate with @open-telemetry/collector-approvers / @open-telemetry/collector-maintainers to automate that (and maybe enrich the metadata file even further)
We leverage mdatagen files in the Splunk distro's docs using client side JS. For example, this table...
Is built using this file...
...through this JS logic:
https://github.com/splunk/public-o11y-docs/blob/main/_static/jsonpull-splunk.js
Desired feature or idea: The Collector's internal metrics were recently added to the metadata generating tool
mdatagen
in https://github.com/open-telemetry/opentelemetry-collector/pull/10170. Basic documentation is now automatically generated in repo markdown files for each component, for example:A manually compiled list of metrics is included on the internal telemetry page of the website, but concerns have been raised about maintaining it.
Can we incorporate the
mdatagen
automated docs into the OTel website?Additional context:
mdatagen
's schema be modified to include an optional field forlevel
?