From 45a90be887a76698ab4a4d6059c5d300c1bcc3fe Mon Sep 17 00:00:00 2001 From: Guangya Liu Date: Tue, 7 Jan 2025 21:25:44 -0500 Subject: [PATCH] [chore] Added guidance for adding new table (#1722) Signed-off-by: Guangya Liu Co-authored-by: Liudmila Molkova --- CONTRIBUTING.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 433141408..111d35baa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -169,7 +169,23 @@ You can also take examples from past changes inside the `schemas` folder. ### 2. Update the markdown files After updating the YAML file(s), you need to update -the respective markdown files. For this, run the following commands: +the respective markdown files. +If you want to update existing tables, just run the following commands: + +```bash +make table-generation attribute-registry-generation +``` + +When defining new telemetry signals (spans, metrics, events, resources) in YAML, +make sure to add a new markdown section describing them. Add the following +code-snippet into the markdown file: + +``` + + +``` + +Then run markdown generation commands: ```bash make table-generation attribute-registry-generation