From 0005a84772d53d53b6d88d87b7654755d6104063 Mon Sep 17 00:00:00 2001 From: Liudmila Molkova Date: Tue, 17 Sep 2024 04:32:05 -0700 Subject: [PATCH] Update schema url to the weaver one and replace other links to build-tools (#1405) Co-authored-by: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> --- .vscode/settings.json | 2 +- CONTRIBUTING.md | 8 ++++---- model/README.md | 10 ++++------ 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 7741a3e1f5..1a42dbf20a 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -10,7 +10,7 @@ "MD040": false, }, "yaml.schemas": { - "https://raw.githubusercontent.com/open-telemetry/build-tools/v0.24.0/semantic-conventions/semconv.schema.json": [ + "https://raw.githubusercontent.com/open-telemetry/weaver/v0.9.2/schemas/semconv.schema.json": [ "model/**/*.yaml" ] }, diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b529d843ef..27a66ed954 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,7 +91,7 @@ environment configured: ### 1. Modify the YAML model Refer to the -[Semantic Convention YAML Language](https://github.com/open-telemetry/build-tools/blob/v0.25.0/semantic-conventions/syntax.md) +[Semantic Convention YAML Language](https://github.com/open-telemetry/weaver/blob/main/schemas/semconv-syntax.md) to learn how to make changes to the YAML files. #### Code structure @@ -343,14 +343,14 @@ make markdown-link-check ### Version compatibility check -Semantic conventions are validated for backward compatibility with last released versions. Here's [the full list of compatibility checks](https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/README.md#version-compatibility-check). +Semantic conventions are validated for backward compatibility with last released versions. Here's [the full list of compatibility checks](./policies/compatibility.rego). Removing attributes, metrics, or enum members is not allowed, they should be deprecated instead. It applies to stable and experimental conventions and prevents semantic conventions auto-generated libraries from introducing breaking changes. -You can run backward compatibility check in all yaml files with the following command: +You can run backward compatibility check (along with other policies) in all yaml files with the following command: ```bash -make compatibility-check +make check-policies ``` ## Updating the referenced specification version diff --git a/model/README.md b/model/README.md index ec76e3f883..ce6fb75e93 100644 --- a/model/README.md +++ b/model/README.md @@ -14,12 +14,12 @@ Semantic conventions for the spec MUST adhere to the [attribute requirement level](../docs/general/attribute-requirement-level.md), and [metric requirement level](../docs/general/metric-requirement-level.md) conventions. -Refer to the [syntax](https://github.com/open-telemetry/build-tools/tree/v0.25.0/semantic-conventions/syntax.md) +Refer to the [syntax](https://github.com/open-telemetry/weaver/blob/main/schemas/semconv-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/v0.25.0/semantic-conventions/README.md) for what extension you need. +[the generator README](https://github.com/open-telemetry/weaver/blob/main/schemas/semconv-syntax.md) for what extension you need. ## Generating markdown @@ -32,12 +32,10 @@ make table-generation For more information, see the [Weaver](https://github.com/open-telemetry/weaver) as our code generations tool. -Using Weaver, it is also possible to generate code for use in OpenTelemetry -language projects, in addition to build-tools. See also: -* [Markdown Templates](https://github.com/open-telemetry/semantic-conventions/tree/main/templates/registry/markdown) +* [Markdown Templates](../templates/registry/markdown) * [Weaver Template Documentation](https://github.com/open-telemetry/weaver/blob/main/crates/weaver_forge/README.md) * [Weaver Usage Documentation](https://github.com/open-telemetry/weaver/blob/main/docs/usage.md#registry-generate) -* [Build Tools - Code Generator](https://github.com/open-telemetry/build-tools/tree/main/semantic-conventions#code-generator) +* [Code Generator Documentation](../docs/non-normative/code-generation.md)