Skip to content

Commit e70f1fa

Browse files
authored
Improve semconv README, link to naming rules. (#1838)
1 parent 09944db commit e70f1fa

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

semantic_conventions/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,17 @@ i.e.:
1414

1515
## Writing semantic conventions
1616

17+
Semantic conventions for the spec MUST adhere to the
18+
[attribute naming conventions](../specification/common/attribute-naming.md).
19+
1720
Refer to the [syntax](https://github.com/open-telemetry/build-tools/tree/main/semantic-conventions/syntax.md)
1821
for how to write the YAML files for semantic conventions and what the YAML properties mean.
1922

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

24-
## Generation
27+
## Generating markdown
2528

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

0 commit comments

Comments
 (0)