open-telemetry / opentelemetry.io

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

Avoiding environment variable spec & doc drift #1463

Open chalin opened 2 years ago

chalin commented 2 years ago

@cartermp, @austinlparker, @svrnm - Since

we're now in a position where env. variables are described in two places, e.g.:

Our effort from the start has been to try to keep things DRY, to avoid drift, etc. To resolve this we can:

Other suggestions?

Also related:

cartermp commented 2 years ago

Hmm, in general I'm not opposed to trying to avoid drift, but I worry that it will lead to the wrong kind of content. There's a legitimate need to understand the spec, but the spec is at times not detailed enough (e.g, example usage) or far too detailed and clearly not written for a user of OpenTelemetry (e.g., explaining the exporter endpoint variables). I don't think we can change the spec here, but I really wouldn't want to make the spec just be the docs either.