Skip to content

Commit

Permalink
Improve semconv README, link to naming rules. (#1838)
Browse files Browse the repository at this point in the history
  • Loading branch information
Oberon00 authored Jul 30, 2021
1 parent 09944db commit e70f1fa
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion semantic_conventions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,17 @@ i.e.:

## Writing semantic conventions

Semantic conventions for the spec MUST adhere to the
[attribute naming conventions](../specification/common/attribute-naming.md).

Refer to the [syntax](https://github.com/open-telemetry/build-tools/tree/main/semantic-conventions/syntax.md)
for how to write the YAML files for semantic conventions and what the YAML properties mean.

A schema file for VS code is configured in the `/.vscode/settings.json` of this
repository, enabling auto-completion and additional checks. Refer to
[the generator README](https://github.com/open-telemetry/build-tools/tree/main/semantic-conventions/README.md) for what extension you need.

## Generation
## Generating markdown

These YAML files are used by the make target `table-generation` to generate consistently
formatted Markdown tables for all semantic conventions in the specification. Run it from the root of this repository using the command
Expand Down

0 comments on commit e70f1fa

Please sign in to comment.