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

Website Glossary vs. Spec Glossary #865

Closed
Tracked by #1268
svrnm opened this issue Oct 26, 2021 · 3 comments
Closed
Tracked by #1268

Website Glossary vs. Spec Glossary #865

svrnm opened this issue Oct 26, 2021 · 3 comments

Comments

@svrnm
Copy link
Member

svrnm commented Oct 26, 2021

There are two glossaries now, one on the website (https://opentelemetry.io/docs/concepts/glossary/) and one in the spec (https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/glossary.md).

From an end-user perspective this is confusing. An ideal solution would be having only one, but I assume that's not an easy task: My assumption is (I might be wrong here!), that the glossary in the spec are binding definitions of what the terms mean in the context of the spec and that the glossary on the website enriches those by additional terms that either might not be relevant for the spec or don't need a binding definition.

Based on that assumption I suggest two steps:

  • Short term it would be good if the website glossary would link to the spec and call out the differences
  • Long term it would be great if the website glossary would pull in the glossary from the spec and enrich it with additional terms.

Beyond that, the glossary includes a few definitions I think should be part of the spec glossary, e.g. service (see open-telemetry/opentelemetry-specification#2050)

@svrnm svrnm added the bug Something isn't working label Oct 26, 2021
@chalin
Copy link
Contributor

chalin commented Oct 28, 2021

Relevant to this issue: #866

@chalin chalin removed the bug Something isn't working label Oct 28, 2021
@chalin
Copy link
Contributor

chalin commented Oct 29, 2021

Note that this work would likely fall under #770.

@svrnm
Copy link
Member Author

svrnm commented Oct 29, 2021

@chalin rg. #866, this would require that the terms from both glossaries are merged? Not sure if this is easy to have the ones from the website all added to the spec

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants