Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move "hardcoded" notes from metric semconv md files to the notes field in YAML #71

Open
joaopgrassi opened this issue Jun 1, 2023 · 0 comments
Assignees
Labels
editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. enhancement New feature or request tooling Regarding build, workflows, build-tools, ...

Comments

@joaopgrassi
Copy link
Member

The build tools does not render today the note field on a metric defined in yaml. This has caused some of the semconv markdown files to include notes "hardcoded" in the markdown files.

When open-telemetry/build-tools#177 is merged, the tool will then properly render the notes and link it to the description column in the metrics table, same way done for attribute notes.

We then need to move the existing notes from the markdown file to their yaml definitions and re-render the markdown so the notes are then not hardcoded anymore.

I looked and I only found ones that need changing in the runtime-environment-metrics.md, but things might change with incoming PRs so need to double check when work on this starts

@joaopgrassi joaopgrassi added enhancement New feature or request editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. tooling Regarding build, workflows, build-tools, ... labels Jun 1, 2023
@github-actions github-actions bot added the Stale label Feb 18, 2024
@joaopgrassi joaopgrassi removed the Stale label Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. enhancement New feature or request tooling Regarding build, workflows, build-tools, ...
Projects
None yet
Development

No branches or pull requests

2 participants