Opentelemetry-specification: Autogenerate and publish semantic convention tables

Created on 26 Feb 2021  路  2Comments  路  Source: open-telemetry/opentelemetry-specification

The semantic convention YAMLs require https://github.com/open-telemetry/build-tools/tree/main/semantic-conventions to be generated into human readable tables. Currently, it's very difficult for people who are not involved in OpenTelemetry to read the semantic conventions. It's affecting their engagement with the project and disserving the project because the references are not accessible. Automate the generation by generating and publishing the tables after each PR.

miscellaneous

Most helpful comment

I would vote to move the current semantic_conventions folder to a subfolder somewhere. Even for someone involved in OpenTelemetry, I have a habit of accidentally opening that folder, and realizing I meant to go to the other one with the MD files. The yaml are too discoverable despite being mostly only used for producing, not consuming.

All 2 comments

They seem to be already autogenerated in this repo, e.g. https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions.

Feel free to reopen this if there is anything else to do.

I would vote to move the current semantic_conventions folder to a subfolder somewhere. Even for someone involved in OpenTelemetry, I have a habit of accidentally opening that folder, and realizing I meant to go to the other one with the MD files. The yaml are too discoverable despite being mostly only used for producing, not consuming.

Was this page helpful?
0 / 5 - 0 ratings