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

[docs] Refer to OTel spec at main? #179

Closed
chalin opened this issue Jul 7, 2023 · 2 comments · Fixed by #185
Closed

[docs] Refer to OTel spec at main? #179

chalin opened this issue Jul 7, 2023 · 2 comments · Fixed by #185
Assignees

Comments

@chalin
Copy link
Contributor

chalin commented Jul 7, 2023

The docs contain links like this: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0.

Can these be changed to refer to main, or at least the latest version of the OTel spec?

/cc @svrnm @cartermp @jsuereth @joaopgrassi

@jsuereth
Copy link
Contributor

We want to tie to a specific version of the specification from our work. We have a script to automatically update version, I'll run that tied to this bug.

@chalin chalin changed the title [docs] Refer to OTel spec at main [docs] Refer to OTel spec at main? Jul 10, 2023
@chalin
Copy link
Contributor Author

chalin commented Jul 10, 2023

We want to tie to a specific version of the specification from our work.

Ok

We have a script to automatically update version

Good.


@jsuereth - I need to clarify something though. You had the following point, originally from open-telemetry/opentelemetry.io#2908, but now tracked via:

Let's suppose that the website is hosting version X of the OTel spec. When publishing semconv, how should we handle links into the OTel spec? Consider these cases:

  1. Semconv page links to OTel spec version X
  2. Semconv page links to OTel spec version Y, where Y != X
  3. Semconv page links to OTel spec at main

In cases (1) and (3), it makes sense to link to the website-local page of the spec. What shall we do in the case of (2), keep the external link? (Ideally, we want to keep readers on the website, but it might not be possible in this last case.)

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

Successfully merging a pull request may close this issue.

2 participants