chore(external docs): generate global option configuration automatically from Rust code #22345
+761
−938
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.
Summary
Aiming to solve the issue mentioned in #21348 (comment), and resolve it by generate a global option configuration page by introducing a new
global_option
configurational component macro. I also update the corresponding Ruby code for generating component docs. It looks worked.I want to emphasize that this is not a production code but rather that a PoC. I would refactor the code (especially for the Ruby code, first time to write Ruby) until all reviewers would agree my solution.
I guess it would be a very long procedure to review the code and the generating documents, especially for the difference the manually-written configuration page and the generated one from Rust code. I will help them as much as possible.
TODO:
global_option
configurational component macro for EVERY global option configurationwebsite/cue/reference/components/transforms/log_to_metric.cue
Change Type
Is this a breaking change?
How did you test this PR?
make generate-component-docs cd website make run-production-site-locally
Does this PR include user facing changes?
Checklist
make check-all
is a good command to run locally. This check isdefined here. Some of these
checks might not be relevant to your PR. For Rust changes, at the very least you should run:
cargo fmt --all
cargo clippy --workspace --all-targets -- -D warnings
cargo nextest run --workspace
(alternatively, you can runcargo test --all
)Cargo.lock
), pleaserun
dd-rust-license-tool write
to regenerate the license inventory and commit the changes (if any). More details here.References
Enrichment table
Secret