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

feat(dev): add config IDE autocompletion guide #22329

Merged
merged 9 commits into from
Jan 31, 2025
Merged

Conversation

pront
Copy link
Member

@pront pront commented Jan 30, 2025

Summary

Adds a new guide for config IDE autocompletion based on Vector's schema.

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?

For the command:

cargo run -- generate-schema -o vector-schema.json

For the guide:

cd website && make serve

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

closes: #22326

@pront pront requested a review from bfung January 30, 2025 19:26
@pront pront requested review from a team as code owners January 30, 2025 19:26
@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Jan 30, 2025
Copy link
Contributor

@michaelcretzman michaelcretzman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with minor suggestions

website/content/en/guides/developer/_index.md Outdated Show resolved Hide resolved
@datadog-vectordotdev
Copy link

datadog-vectordotdev bot commented Jan 30, 2025

Datadog Report

Branch report: pront/gen-schema-out
Commit report: 86264bf
Test service: vector

✅ 0 Failed, 7 Passed, 0 Skipped, 25.47s Total Time

@pront pront requested a review from jszwedko January 30, 2025 20:43
Copy link
Contributor

@bfung bfung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very cool!

@pront pront added this pull request to the merge queue Jan 31, 2025
Merged via the queue into master with commit f09af60 Jan 31, 2025
57 checks passed
@pront pront deleted the pront/gen-schema-out branch January 31, 2025 20:34
pront added a commit that referenced this pull request Jan 31, 2025
* chore(cli): add output path option to generate-schema

* feat(dev): add config IDE autocompletion guide (contains tweaks to generate-schema)

* changelog

* spellcheck

* spellcheck

* Update website/content/en/guides/developer/_index.md

Co-authored-by: Michael Cretzman <[email protected]>

* Update website/content/en/guides/developer/config-autocompletion.md

Co-authored-by: Michael Cretzman <[email protected]>

* Update website/content/en/guides/developer/config-autocompletion.md

Co-authored-by: Michael Cretzman <[email protected]>

* update weights

---------

Co-authored-by: Michael Cretzman <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Changes in this PR do not need user-facing explanations in the release changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how to integrate Vector config schema with IDEs
3 participants