docs(website): convert TOML config examples to YAML#25163
Merged
Conversation
YAML is Vector's recommended and default configuration format. This converts all TOML-only config examples in website docs, guides, blog posts, and highlight files to YAML for consistency. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
pront
added
domain: config
Update docs that mention TOML/YAML/JSON support to explicitly recommend YAML as the default configuration format. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
github-actions
bot
removed
the
domain: external docs
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 93dafba727
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
website/content/en/docs/reference/configuration/template-syntax.md
Outdated
Show resolved
Hide resolved
Instructs AI tools to generate Vector config in YAML unless explicitly asked otherwise. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Fix invalid YAML escape in template-syntax.md (use single quotes) - Fix `transform:` typo to `transforms:` in 0-25-0-upgrade-guide.md - Update remaining `vector.toml` prose references to `vector.yaml` - Remove anachronistic version reference from 2020 highlight Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add tabbed config format picker to all examples so users can toggle between YAML and TOML. Defaults to YAML. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
9 tasks
rtrieu
approved these changes
Apr 10, 2026
bfung
approved these changes
Apr 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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
Convert all TOML-only configuration examples across the Vector website to YAML
and add explicit recommendations for YAML as the default configuration format.
Motivation:
website examples were still written in TOML. This creates a confusing
experience for new users.
explicit recommendations, we guide users toward the format that aligns with
the broader ecosystem (Kubernetes, Helm, etc.).
documentation is consistent. Having a single canonical format across all
examples reduces ambiguity and improves the quality of AI-generated Vector
configurations.
Changes:
.tomlto.yaml_index.md) untouchedVector configuration
N/A (docs-only change)
How did you test this PR?
Visual inspection of converted YAML blocks for correctness.
Change Type
Is this a breaking change?
Does this PR include user facing changes?
no-changeloglabel to this PR.🤖 Generated with Claude Code