Skip to content

docs(config): link to shared declarative config spec conformance matrix#5347

Draft
MikeGoldsmith wants to merge 5 commits into
open-telemetry:mainfrom
MikeGoldsmith:mike/config-conformance-matrix
Draft

docs(config): link to shared declarative config spec conformance matrix#5347
MikeGoldsmith wants to merge 5 commits into
open-telemetry:mainfrom
MikeGoldsmith:mike/config-conformance-matrix

Conversation

@MikeGoldsmith

@MikeGoldsmith MikeGoldsmith commented Jun 24, 2026

Copy link
Copy Markdown
Member

Description

Adds a pointer from the Python SDK's declarative configuration package README to the shared language support status matrix in opentelemetry-configuration, so the Python conformance status lives alongside the other languages instead of being duplicated per language SDK.

Originally this PR added a Python-specific spec-conformance.md to the SDK repo. After discussion on open-telemetry/opentelemetry-js#6846 (where the same approach was being taken there), the consensus is that conformance status should be tracked once in the shared config repo, not duplicated per language. Reworked accordingly:

  • Drop the in-tree spec-conformance.md.
  • Update the SDK config package README with a "Spec conformance" section pointing at the shared matrix and noting that schema/meta_schema_language_python.yaml in the config repo is the source of truth.
  • Rewrite the changelog fragment to describe the new shape.

Closes #5346.

Dependencies

Type of change

  • This change requires a documentation update

How Has This Been Tested?

  • tox -e docs builds clean.

Does This PR Require a Contrib Repo Change?

  • Yes.
  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@MikeGoldsmith MikeGoldsmith requested a review from a team as a code owner June 24, 2026 12:42
@MikeGoldsmith MikeGoldsmith changed the title docs(configuration): publish declarative config spec conformance matrix docs(config): publish declarative config spec conformance matrix Jun 24, 2026
@herin049

Copy link
Copy Markdown
Contributor

Does adding it here not work?

@ocelotl

ocelotl commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Does adding it here not work?

@MikeGoldsmith I wonder what is the motivation for this PR, is the compliance matrix in the spec not detailed enough?

In any case, having this new matrix here is harmless but I understand the point of @herin049 above, I am also curious.

@MikeGoldsmith

Copy link
Copy Markdown
Member Author

You're both right, I'm going to update to link to the compatability matrix in the config repo itself. Although, python is on that list yet, so I'll work on adding it there first 👍🏻

@MikeGoldsmith MikeGoldsmith changed the title docs(config): publish declarative config spec conformance matrix docs(config): link to shared declarative config spec conformance matrix Jun 25, 2026

@xrmx xrmx left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Blocker until we get the config repo updated

@github-project-automation github-project-automation Bot moved this to Reviewed PRs that need fixes in Python PR digest Jun 25, 2026
@MikeGoldsmith MikeGoldsmith marked this pull request as draft June 25, 2026 12:54
@MikeGoldsmith MikeGoldsmith added the config Issues and PRs related to implementing Declarative Config label Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

config Issues and PRs related to implementing Declarative Config

Projects

Status: Reviewed PRs that need fixes

Development

Successfully merging this pull request may close these issues.

docs(configuration): publish a declarative config spec conformance matrix

4 participants