Dynamic declarative configuration spec types page#9850
Merged
Conversation
6 tasks
Member
Author
|
there's something odd going on with the links, im working on figuring it out |
jack-berg
approved these changes
May 12, 2026
Member
jack-berg
left a comment
There was a problem hiding this comment.
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
OpenTelemetryConfigurationroot 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.
vitorvasc
approved these changes
May 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Yes, I can answer maintainer questions about the content of this PR, without using AI. ↩