open-telemetry / opentelemetry.io

The OpenTelemetry website and documentation
https://opentelemetry.io
Creative Commons Attribution 4.0 International
512 stars 1.09k forks source link

Website Glossary vs. Spec Glossary #865

Closed svrnm closed 2 years ago

svrnm commented 2 years ago

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:

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

chalin commented 2 years ago

Relevant to this issue: #866

chalin commented 2 years ago

Note that this work would likely fall under #770.

svrnm commented 2 years ago

@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