Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(external docs): generate global option configuration automatically from Rust code #22345

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

titaneric
Copy link
Contributor

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:

  1. get every reviwers' approvals for the change
  2. introduce global_option configurational component macro for EVERY global option configuration
  3. introduce overlay and decorated page for the configuration page like to one in website/cue/reference/components/transforms/log_to_metric.cue
  4. write dev docs if needed

Change Type

  • Bug fix
  • New feature
  • Non-functional (chore, refactoring, docs)
  • Performance

Is this a breaking change?

  • Yes
  • No

How did you test this PR?

make generate-component-docs
cd website
make run-production-site-locally

Does this PR include user facing changes?

  • Yes. Please add a changelog fragment based on our guidelines.
  • No. A maintainer will apply the "no-changelog" label to this PR.

Checklist

  • Please read our Vector contributor resources.
    • make check-all is a good command to run locally. This check is
      defined 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 run cargo test --all)
  • If this PR introduces changes Vector dependencies (modifies Cargo.lock), please
    run dd-rust-license-tool write to regenerate the license inventory and commit the changes (if any). More details here.

References

Enrichment table
image

Secret
image

@github-actions github-actions bot added domain: ci Anything related to Vector's CI environment domain: external docs Anything related to Vector's external, public documentation labels Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain: ci Anything related to Vector's CI environment domain: external docs Anything related to Vector's external, public documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant