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

Add documentation to the semantic convention YAML models directory #979

Closed
justinfoote opened this issue Sep 22, 2020 · 0 comments · Fixed by #980
Closed

Add documentation to the semantic convention YAML models directory #979

justinfoote opened this issue Sep 22, 2020 · 0 comments · Fixed by #980
Labels
area:miscellaneous For issues that don't match any other area label area:semantic-conventions Related to semantic conventions release:after-ga Not required before GA release, and not going to work on before GA spec:miscellaneous For issues that don't match any other spec label

Comments

@justinfoote
Copy link
Member

I found the YAML files in the semantic_conventions directory at the root of this repository to be something of a mystery. When I first discovered them, I thought they were duplicates of the semantic conventions found in markdown in the specs. It took quite a bit of digging to find this pr and issue and subsequently this build tool, and now I've used the docker build tool to generate semantic convention markdown.

I propose that we add a README to the main directory of the semantic conventions with links out to the build tools, so the purpose of these files will be more obvious to newcomers.

@justinfoote justinfoote added the spec:miscellaneous For issues that don't match any other spec label label Sep 22, 2020
@Oberon00 Oberon00 added area:miscellaneous For issues that don't match any other area label area:semantic-conventions Related to semantic conventions release:after-ga Not required before GA release, and not going to work on before GA labels Sep 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:miscellaneous For issues that don't match any other area label area:semantic-conventions Related to semantic conventions release:after-ga Not required before GA release, and not going to work on before GA spec:miscellaneous For issues that don't match any other spec label
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants