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

Avoiding environment variable spec & doc drift #1463

Open
chalin opened this issue Jun 20, 2022 · 1 comment
Open

Avoiding environment variable spec & doc drift #1463

chalin opened this issue Jun 20, 2022 · 1 comment
Labels
cleanup/refactoring discussion Input from everyone is helpful to drive this forward e0-minutes Effort: < 60 min e1-hours Effort: < 8 hrs p2-medium

Comments

@chalin
Copy link
Contributor

chalin commented Jun 20, 2022

@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:

  • Remove the corresponding definitions from the spec (if they are considered non-normative)
  • Generate the local docs directly from the spec.

Other suggestions?

Also related:

@cartermp
Copy link
Contributor

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.

@theletterf theletterf added the discussion Input from everyone is helpful to drive this forward label Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup/refactoring discussion Input from everyone is helpful to drive this forward e0-minutes Effort: < 60 min e1-hours Effort: < 8 hrs p2-medium
Projects
None yet
Development

No branches or pull requests

3 participants