refactor(vdev): migrate component example generation - #26007
Draft
pront wants to merge 1 commit into
Draft
Conversation
🎉 All green!🧪 All tests passed 🔗 Commit SHA: 7105763 | Docs | Datadog PR Page | Give us feedback! |
pront
force-pushed
the
pront/vdev-component-example-generation
branch
from
August 3, 2026 19:01
eefa8aa to
ea49a2b
Compare
pront
force-pushed
the
pront/vdev-component-example-generation
branch
from
August 3, 2026 19:06
ea49a2b to
c5f7aac
Compare
pront
force-pushed
the
pront/vdev-component-example-generation
branch
from
August 3, 2026 19:45
c5f7aac to
0c746c0
Compare
pront
force-pushed
the
pront/vdev-component-example-generation
branch
from
August 3, 2026 20:25
0c746c0 to
d1d7927
Compare
pront
force-pushed
the
pront/vdev-component-example-generation
branch
from
August 3, 2026 20:38
d1d7927 to
7105763
Compare
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.
Motivation
Component documentation generation is currently split across vdev schema resolution,
scripts/cue.sh, and a JavaScript example generator that passes data throughwebsite/data/docs.json. This makes the developer workflow harder to own, reuse, and optimize as one pipeline.This follow-up consolidates the pipeline in vdev while preserving the already-merged example artifacts as a strict compatibility boundary.
Summary
scripts/cue.sh buildintocargo vdev build docs-json.make cue-buildthrough the native vdev command.check-generated-docs; its validator now consumes the artifacts the check already generated.website/generated/example-configs/byte-for-byte unchanged throughout the refactor; those files are the parity fixtures.The JavaScript component-example generator is intentionally unchanged in this first slice. It still
consumes the final CUE model, so this change establishes the native vdev boundary without altering
the generated examples or website output.
Developer impact
Contributors can now build the CUE docs model through vdev, using deterministic source discovery and
an explicit output path. The end state gives contributors one Rust developer tool for component-doc
and example generation, rather than coordinating shell and JavaScript entry points. It should also
eliminate
website/data/docs.jsonas an internal generator-to-generator hand-off, while continuingto produce it when Hugo needs it.
Vector configuration
Not applicable.
How did you test this PR?
make check-markdownmake check-clippycargo vdev build docs-json --output /tmp/vdev-component-docs.jsonbyte-for-byte withscripts/cue.sh buildoutput.make -C website config-examples;website/generated/example-configs/remained unchanged.make check-generated-docs(250 examples validated; 4 trace-only examples skipped; committed YAML fixtures unchanged).Is this a breaking change?
Does this PR include user facing changes?
no-changeloglabel to this PR.References