Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move syntax.md to build-tools, improve semconv README. #1825

Merged
merged 3 commits into from
Jul 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,10 @@
"MD033": false,
"MD040": false,
},
"yaml.schemas": {
"https://raw.githubusercontent.com/open-telemetry/build-tools/main/semantic-conventions/semconv.schema.json": [
"semantic_conventions/**/*.yaml"
]
},
"json.schemaDownload.enable": true
}
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ See:
### Semantic Conventions update

Semantic convention is declared in YAML files and markdown tables are
generated from these files. Read about semantic convention updates [here](./semantic_conventions/syntax.md).
generated from these files. Read about semantic convention updates [here](./semantic_conventions/README.md).

### Autoformatting

Expand Down
19 changes: 14 additions & 5 deletions semantic_conventions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,22 @@ The YAML descriptions of semantic convention contained in this directory are int
be used by the various OpenTelemetry language implementations to aid in automatic
generation of semantics-related code.

⚠ If you want to read the semantic conventions and not edit them, please see
the generated markdown output under `/specification/*/semantic_conventions/`,
i.e.:

* [Trace semantic conventions](../specification/trace/semantic_conventions/README.md)
* [Metric semantic conventions](../specification/metrics/semantic_conventions/README.md)
* [Resource semantic conventions](../specification/resource/semantic_conventions/README.md)

## Writing semantic conventions

Refer to the [syntax](./syntax.md) for how to write the YAML files for semantic conventions.
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

Expand All @@ -26,7 +39,3 @@ See also:

* [Markdown Tables](https://github.com/open-telemetry/build-tools/tree/main/semantic-conventions#markdown-tables)
* [Code Generator](https://github.com/open-telemetry/build-tools/tree/main/semantic-conventions#code-generator)

## Description of the model

The fields and their expected values are presented in [syntax.md](./syntax.md).
235 changes: 0 additions & 235 deletions semantic_conventions/syntax.md

This file was deleted.