Skip to content

docs(website): Fix config extension typo in Windows command (from-source.md) #23166

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tenghuanhe
Copy link

Corrects the configuration file extension in the Windows startup command for Vector. The original command .\target\release\vector --config config\vector.toml incorrectly used TOML extension, while Vector's actual config file is YAML format.

Summary

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?

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.

Notes

  • Please read our Vector contributor resources.
  • Do not hesitate to use @vectordotdev/vector to reach out to us regarding this PR.
  • The CI checks run only after we manually approve them.
    • We recommend adding a pre-push hook, please see this template.
    • Alternatively, we recommend running the following locally before pushing to the remote branch:
      • cargo fmt --all
      • cargo clippy --workspace --all-targets -- -D warnings
      • cargo nextest run --workspace (alternatively, you can run cargo test --all)
      • ./scripts/check_changelog_fragments.sh
  • After a review is requested, please avoid force pushes to help us review incrementally.
    • Feel free to push as many commits as you want. They will be squashed into one before merging.
    • For example, you can run git merge origin master and git push.
  • If this PR introduces changes Vector dependencies (modifies Cargo.lock), please
    run cargo vdev build licenses to regenerate the license inventory and commit the changes (if any). More details here.

References

Corrects the configuration file extension in the Windows startup command for Vector. 
The original command `.\target\release\vector --config config\vector.toml` incorrectly used TOML extension, 
while Vector's actual config file is YAML format.
@tenghuanhe tenghuanhe requested a review from a team as a code owner June 8, 2025 11:22
@bits-bot
Copy link

bits-bot commented Jun 8, 2025

CLA assistant check
All committers have signed the CLA.

@tenghuanhe tenghuanhe changed the title Fix config extension typo in Windows command (from-source.md) docs(website): Fix config extension typo in Windows command (from-source.md) Jun 8, 2025
@brett0000FF brett0000FF self-assigned this Jun 9, 2025
@brett0000FF brett0000FF removed their assignment Jun 9, 2025
@pront pront enabled auto-merge June 9, 2025 20:44
@pront
Copy link
Member

pront commented Jun 9, 2025

Thanks @tenghuanhe

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants