docs(external): generate global option and common field from Rust macro #22408
Conversation
github-actions
bot
added
domain: ci
There was a problem hiding this comment.
Thank you @titaneric, these improvements are much appreciated 👍
pront
added
the
no-changelog
pront
changed the title
| common: false | ||
| required: false | ||
| } | ||
| acknowledgements: { |
There was a problem hiding this comment.
Please note that these configuration are generated from the Rust original code. I don't port the config from configuration.cue to Rust docs.
| @@ -798,6 +798,17 @@ def resolve_schema(root_schema, schema) | |||
| end | |||
| end | |||
|
|
|||
| # required for global option configuration | |||
| is_common_field = get_schema_metadata(schema, 'docs::common') | |||
There was a problem hiding this comment.
I think it's temporary solution for Ruby docs generator, and I do believe that it would be much bettern when we port Ruby code to Rust.
| updated before they expire and are removed. | ||
|
|
||
| Set this to a value larger than your `internal_metrics` scrape interval (default 5 minutes) | ||
| that metrics live long enough to be emitted and captured, |
There was a problem hiding this comment.
| that metrics live long enough to be emitted and captured, | |
| so metrics live long enough to be emitted and captured. |
|
|
||
| configuration: { | ||
| // expire_metrics's type is a little bit tricky, we could not generate `uint` from `docs::type_override` metadata macro easily. |
There was a problem hiding this comment.
It seems like this comment is internal, should it be removed?
There was a problem hiding this comment.
The comment I wrote would not be displayed on the docs, and I think it might need to be kept since it's specifically handled case.
There was a problem hiding this comment.
@jhgilbert , would you please check it?
There was a problem hiding this comment.
Double checked and leaving the comment is fine.
Pull Request is not mergeable
Summary
This is follow-up PR for #22345
Change Type
Is this a breaking change?
How did you test this PR?
make generate-component-docs cd website make run-production-site-locallyDoes this PR include user facing changes?
Checklist
make check-allis 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 --allcargo clippy --workspace --all-targets -- -D warningscargo nextest run --workspace(alternatively, you can runcargo test --all)Cargo.lock), pleaserun
dd-rust-license-tool writeto regenerate the license inventory and commit the changes (if any). More details here.References