Skip to content

Commit

Permalink
Add README describing use of semantic convention YAML models (open-te…
Browse files Browse the repository at this point in the history
  • Loading branch information
justinfoote authored Sep 23, 2020
1 parent 167f1c1 commit a67bd5a
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions semantic_conventions/README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit a67bd5a

Please sign in to comment.