From a67bd5a0991c6a73e6f57b88a4ae6fce807f8efc Mon Sep 17 00:00:00 2001 From: Justin Foote Date: Wed, 23 Sep 2020 07:08:31 -0700 Subject: [PATCH] Add README describing use of semantic convention YAML models (#980) --- semantic_conventions/README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 semantic_conventions/README.md diff --git a/semantic_conventions/README.md b/semantic_conventions/README.md new file mode 100644 index 00000000000..f5425c421ae --- /dev/null +++ b/semantic_conventions/README.md @@ -0,0 +1,28 @@ +# YAML Model for Semantic Conventions + +The YAML descriptions of semantic convention contained in this directory are intended to +be used by the various OpenTelemetry language implementations to aid in automatic +generation of semantics-related code. + +## Generation + +These YAML files are used by the make target `table-generation` to generate consistently +formattted Markdown tables for all semantic conventions in the specification. Run it from the root of this repository using the command + +``` +make table-generation +``` + +For more information, see the [semantic convention generator](https://github.com/open-telemetry/build-tools/tree/master/semantic-conventions) +in the OpenTelemetry build tools repository. +Using this build tool, it is also possible to generate code for use in OpenTelemetry +language projects. + +See also: + +* [Markdown Tables](https://github.com/open-telemetry/build-tools/tree/master/semantic-conventions#markdown-tables) +* [Code Generator](https://github.com/open-telemetry/build-tools/tree/master/semantic-conventions#code-generator) + +## Description of the model + +The fields and their expected values are presented in [syntax.md](./syntax.md).