Skip to content

docs(specs): Publish spec compliance matrix#9358

Open
lehmannro wants to merge 4 commits intoopen-telemetry:mainfrom
lehmannro:spec-matrix
Open

docs(specs): Publish spec compliance matrix#9358
lehmannro wants to merge 4 commits intoopen-telemetry:mainfrom
lehmannro:spec-matrix

Conversation

@lehmannro
Copy link
Contributor

  • I have read and followed the Contributing docs, especially the "First-time contributing?" section.
  • This PR has content that I did not fully write myself.
  • I have the experience and knowledge necessary to understand, review, and validate all content in this PR.1

This will publish the Compliance of Implementations with Specification matrix, currently only on Github, under https://opentelemetry.io/docs/languages/spec-compliance-matrix (titled Spec compliance.)

Footnotes

  1. Yes, I can answer maintainer questions about the content of this PR, without using AI.

The table, which the `opentelemetry-specification` goes to great lengths of
creating and maintaining, is otherwise unused.

This leads to e.g.
[blog posts having to link to](https://opentelemetry.io/blog/2026/stable-declarative-config/)
Github directly through:
*   https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md
Some links in that table are written relative to the
`opentelemetry-specification` repository, which is copied into
`./docs/specs/otel/`.
@lehmannro lehmannro requested a review from a team as a code owner March 8, 2026 12:33
@otelbot-docs otelbot-docs bot added the missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer label Mar 8, 2026
@lehmannro
Copy link
Contributor Author

I realize some of the links are still broken; could I get some indication if the approach is sane in general, then I'll happily tweak adjust-pages.pl some more.

@svrnm
Copy link
Member

svrnm commented Mar 9, 2026

Preview: https://deploy-preview-9358--opentelemetry.netlify.app/docs/languages/spec-compliance-matrix/

Interesting idea & solution, @lehmannro , we need to check a few things here, if this is maintanable long term.

@open-telemetry/spec-sponsors PTAL!

@svrnm svrnm added the sig:spec label Mar 9, 2026
@thompson-tomo
Copy link
Contributor

Would it make more sense for this to reside alongside the spec within the spec branch of the navigation.

It might be useful to see if we could also generate 1 page per language and have that mounted under the appropriate language. That way if someone is looking at the .net docs they can easily see what features have been implemented.

Some links point to `README.md` files which get rendered to `index.html` (or,
the `/` redirect).  This is true for both, links inside the already adjusted
`/docs/specs/otel` tree and outside (`.../semconv`) so we cannot just tweak the
first regexp a little.
@lehmannro
Copy link
Contributor Author

I went and fixed up all links through adjust-pages.pl now. I believe the remaining check-links failures are false positives (they're the Edit this page and View page source links.)

As for where in the navigation this lives, I don't feel strongly. To me, Languages makes most sense because I'd probably use this page when I'm looking at a particular language / across languages, rather than into the specification only. YMMV.

Splitting up sounds like a more involved project because we'd need to fetch the individual YAML files and generate our own tables, much like the current opentelemetry-specification script already does.
I can see value in doing both, so maybe we get this exported now and then, if we still have the appetite (for both the effort and the additional complexity) add per-language tables later?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer sig:spec

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants