Skip to content

Dynamic declarative configuration spec types page#9850

Merged
vitorvasc merged 4 commits into
open-telemetry:mainfrom
jaydeluca:add-types-page
May 13, 2026
Merged

Dynamic declarative configuration spec types page#9850
vitorvasc merged 4 commits into
open-telemetry:mainfrom
jaydeluca:add-types-page

Conversation

@jaydeluca
Copy link
Copy Markdown
Member

@jaydeluca jaydeluca commented May 7, 2026

  • 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

Part of #9521

Builds on top of #9654 and #9842

This introduces the dynamic types page within the spec/configuration directory. One note is that @chalin and I had discussed ensuring there was also an LLM friendly markdown version of the page, and this PR does not handle that. I have accounted for that in my plans for followup PRs.

I have plans for integrating code snippets in a followup as well

Deployment preview: https://deploy-preview-9850--opentelemetry.netlify.app/docs/specs/otel/configuration/types/

cc @jack-berg

Footnotes

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

@jaydeluca jaydeluca requested a review from a team as a code owner May 7, 2026 15:48
@otelbot-docs otelbot-docs Bot added missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer missing:sig-approval Co-owning SIG didn't provide an approval labels May 7, 2026
@github-actions github-actions Bot added CI/infra Repo CI & infrastructure i18n Internationalization and localization sig:spec labels May 7, 2026
@jaydeluca
Copy link
Copy Markdown
Member Author

there's something odd going on with the links, im working on figuring it out

Copy link
Copy Markdown
Member

@jack-berg jack-berg left a comment

Choose a reason for hiding this comment

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

Ah so good. 👏 👏

@open-telemetry/configuration-approvers definitely go check this out.

There's a few missing features from schema-docs.md which I still find useful, but not necessary to start. Let's take OtlpHttpExporter as an example:

  • There's a language support status table that shows the support of each property in each language at a glance.
  • There's a Usages section, that provides links to the other places in the schema where the type is used, and provides a very useful "infinite linking" feature. To help folks get started, the Overview section links to the OpenTelemetryConfiguration root type. <-- That's the common thing you want to do. Start at the root and click down through the property tree. The type column of your tables could also participate in this infinite linking.
  • There's a snippets section, where each reference snippet is included in a collapsible section. Lots of useful little tidbits in these snippets, including explanatory comments.
  • There's a JSON schema source section, that defines the raw JSON schema definition for the type. This is helpful because sometimes the rendering isn't perfectly expressive of the underlying type definition. Sometimes you just gotta go to the source code, and this facilitates that.

@otelbot-docs otelbot-docs Bot removed the missing:sig-approval Co-owning SIG didn't provide an approval label May 12, 2026
@vitorvasc vitorvasc added this pull request to the merge queue May 13, 2026
@otelbot-docs otelbot-docs Bot added ready-to-be-merged This PR is ready to be merged by a maintainer and removed missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer labels May 13, 2026
Merged via the queue into open-telemetry:main with commit 2bd9a5c May 13, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/infra Repo CI & infrastructure i18n Internationalization and localization ready-to-be-merged This PR is ready to be merged by a maintainer sig:spec

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants