[chore] Added guidance for adding new table (#1722)
Signed-off-by: Guangya Liu <gyliu@ibm.com> Co-authored-by: Liudmila Molkova <limolkova@microsoft.com>
This commit is contained in:
parent
f7362c7066
commit
45a90be887
|
|
@ -169,7 +169,23 @@ You can also take examples from past changes inside the `schemas` folder.
|
||||||
### 2. Update the markdown files
|
### 2. Update the markdown files
|
||||||
|
|
||||||
After updating the YAML file(s), you need to update
|
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
|
```bash
|
||||||
make table-generation attribute-registry-generation
|
make table-generation attribute-registry-generation
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue