Skip to content

Commit

Permalink
[chore] Added guidance for adding new table (#1722)
Browse files Browse the repository at this point in the history
Signed-off-by: Guangya Liu <gyliu@ibm.com>
Co-authored-by: Liudmila Molkova <limolkova@microsoft.com>
  • Loading branch information
gyliu513 and lmolkova authored Jan 8, 2025
1 parent f7362c7 commit 45a90be
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
<!-- semconv new-group-id -->
<!-- endsemconv -->
```

Then run markdown generation commands:

```bash
make table-generation attribute-registry-generation
Expand Down

0 comments on commit 45a90be

Please # to comment.