Skip to content

chore(dev): lint yaml inside markdown#25168

Open
bfung wants to merge 9 commits intomasterfrom
bfung/check_yaml_in_markdown
Open

chore(dev): lint yaml inside markdown#25168
bfung wants to merge 9 commits intomasterfrom
bfung/check_yaml_in_markdown

Conversation

@bfung
Copy link
Copy Markdown
Contributor

@bfung bfung commented Apr 10, 2026

Summary

Adds a script to lint and fix yaml inside markdown files.

How did you test this PR?

Run:

$ uv run scripts/md-yaml.py lint website/content/en/docs/reference/configuration/_index.md
$ uv run scripts/md-yaml.py fix website/content/en/docs/reference/configuration/_index.md

Generating this PR

Lint all the changes of `pront/convert-toml-to-yaml-website` branch against `master`

Command

$ git diff --name-only master...HEAD -- '*.md' | xargs uv run scripts/md-yaml.py lint --verbose

Output

AGENTS.md: no YAML blocks found
website/content/en/blog/adaptive-request-concurrency.md: block 1 (line 98) OK
website/content/en/blog/graphql-api.md: block 1 (line 40) OK
website/content/en/blog/graphql-api.md: block 2 (line 199) OK
website/content/en/blog/kubernetes-integration.md: block 1 (line 31) OK
website/content/en/blog/log-namespacing.md: block 1 (line 43) OK
website/content/en/docs/administration/management.md: no YAML blocks found
website/content/en/docs/architecture/guarantees.md: block 1 (line 65) OK
website/content/en/docs/architecture/pipeline-model.md: no YAML blocks found
website/content/en/docs/reference/configuration/_index.md: block 1 (line 22) OK
website/content/en/docs/reference/configuration/_index.md: block 2 (line 285) OK
website/content/en/docs/reference/configuration/_index.md: block 3 (line 299) OK
website/content/en/docs/reference/configuration/_index.md: block 4 (line 309) OK
website/content/en/docs/reference/configuration/_index.md: block 5 (line 321) OK
website/content/en/docs/reference/configuration/_index.md: block 6 (line 332) OK
website/content/en/docs/reference/configuration/_index.md: block 7 (line 346) OK
website/content/en/docs/reference/configuration/_index.md: block 8 (line 377) OK
website/content/en/docs/reference/configuration/_index.md: block 9 (line 411) OK
website/content/en/docs/reference/configuration/_index.md: block 10 (line 479) FAILED
  line 487:8: [error] wrong indentation: expected 6 but found 7 (indentation)
website/content/en/docs/reference/configuration/template-syntax.md: block 1 (line 19) OK
website/content/en/docs/reference/configuration/template-syntax.md: block 2 (line 69) OK
website/content/en/docs/reference/configuration/template-syntax.md: block 3 (line 90) OK
website/content/en/docs/reference/configuration/template-syntax.md: block 4 (line 117) OK
website/content/en/docs/reference/configuration/template-syntax.md: block 5 (line 136) OK
website/content/en/docs/reference/configuration/template-syntax.md: block 6 (line 167) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 1 (line 81) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 2 (line 97) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 3 (line 111) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 4 (line 125) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 5 (line 199) FAILED
  line 201:5: [warning] comment not indented like content (comments-indentation)
  line 204:5: [warning] comment not indented like content (comments-indentation)
  line 206:3: [warning] comment not indented like content (comments-indentation)
website/content/en/docs/reference/configuration/unit-tests.md: block 6 (line 230) FAILED
  line 232:5: [warning] comment not indented like content (comments-indentation)
website/content/en/docs/reference/configuration/unit-tests.md: block 7 (line 263) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 8 (line 280) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 9 (line 298) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 10 (line 341) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 11 (line 350) FAILED
  line 350:3: [error] wrong indentation: expected 0 but found 2 (indentation)
website/content/en/docs/reference/configuration/unit-tests.md: block 12 (line 363) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 13 (line 373) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 14 (line 385) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 15 (line 399) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 16 (line 415) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 17 (line 465) OK
website/content/en/docs/reference/configuration/unit-tests.md: block 18 (line 540) OK
website/content/en/docs/setup/going-to-prod/high-availability.md: block 1 (line 57) OK
website/content/en/guides/advanced/custom-aggregations-with-lua.md: block 1 (line 35) OK
website/content/en/guides/advanced/custom-aggregations-with-lua.md: block 2 (line 80) OK
website/content/en/guides/advanced/custom-aggregations-with-lua.md: block 3 (line 141) OK
website/content/en/guides/advanced/custom-aggregations-with-lua.md: block 4 (line 157) OK
website/content/en/guides/advanced/custom-aggregations-with-lua.md: block 5 (line 169) OK
website/content/en/guides/advanced/custom-aggregations-with-lua.md: block 6 (line 182) OK
website/content/en/guides/advanced/custom-aggregations-with-lua.md: block 7 (line 269) OK
website/content/en/guides/advanced/merge-multiline-logs-with-lua.md: block 1 (line 47) OK
website/content/en/guides/advanced/parsing-csv-logs-with-lua.md: block 1 (line 40) OK
website/content/en/guides/advanced/parsing-csv-logs-with-lua.md: block 2 (line 94) OK
website/content/en/guides/advanced/parsing-csv-logs-with-lua.md: block 3 (line 106) OK
website/content/en/guides/advanced/parsing-csv-logs-with-lua.md: block 4 (line 130) OK
website/content/en/guides/aws/cloudwatch-logs-firehose.md: block 1 (line 83) OK
website/content/en/guides/aws/cloudwatch-logs-firehose.md: block 2 (line 359) OK
website/content/en/guides/aws/cloudwatch-logs-firehose.md: block 3 (line 460) OK
website/content/en/guides/aws/cloudwatch-logs-firehose.md: block 4 (line 490) OK
website/content/en/guides/level-up/managing-complex-configs.md: block 1 (line 51) OK
website/content/en/guides/level-up/managing-complex-configs.md: block 2 (line 87) OK
website/content/en/guides/level-up/managing-complex-configs.md: block 3 (line 111) OK
website/content/en/guides/level-up/managing-complex-configs.md: block 4 (line 145) OK
website/content/en/guides/level-up/managing-complex-configs.md: block 5 (line 196) OK
website/content/en/guides/level-up/managing-complex-configs.md: block 6 (line 224) OK
website/content/en/guides/level-up/managing-complex-configs.md: block 7 (line 233) OK
website/content/en/guides/level-up/managing-complex-configs.md: block 8 (line 243) OK
website/content/en/guides/level-up/managing-schemas.md: block 1 (line 47) OK
website/content/en/guides/level-up/managing-schemas.md: block 2 (line 71) OK
website/content/en/guides/level-up/managing-schemas.md: block 3 (line 96) OK
website/content/en/guides/level-up/managing-schemas.md: block 4 (line 107) OK
website/content/en/guides/level-up/managing-schemas.md: block 5 (line 132) OK
website/content/en/guides/level-up/managing-schemas.md: block 6 (line 210) FAILED
  line 219:5: [warning] comment not indented like content (comments-indentation)
website/content/en/guides/level-up/managing-schemas.md: block 7 (line 232) OK
website/content/en/guides/level-up/managing-schemas.md: block 8 (line 256) OK
website/content/en/guides/level-up/managing-schemas.md: block 9 (line 273) OK
website/content/en/guides/level-up/managing-schemas.md: block 10 (line 296) OK
website/content/en/guides/level-up/managing-schemas.md: block 11 (line 315) OK
website/content/en/guides/level-up/vector-tap-guide.md: block 1 (line 35) OK
website/content/en/guides/level-up/vector-tap-guide.md: block 2 (line 128) OK
website/content/en/guides/level-up/vector-tap-guide.md: block 3 (line 156) OK
website/content/en/highlights/2019-11-25-unit-testing-vector-config-files.md: block 1 (line 30) OK
website/content/en/highlights/2019-12-13-custom-dns.md: block 1 (line 24) OK
website/content/en/highlights/2019-12-16-ec2-metadata.md: block 1 (line 25) OK
website/content/en/highlights/2020-01-07-prometheus-source.md: block 1 (line 29) OK
website/content/en/highlights/2020-01-20-splunk-hec-specify-indexed-fields.md: block 1 (line 25) FAILED
  line 25:2: [error] wrong indentation: expected 0 but found 1 (indentation)
  line 29:1: [error] syntax error: expected '<document start>', but found '<block mapping start>' (syntax)
website/content/en/highlights/2020-02-05-merge-partial-docker-events.md: block 1 (line 24) OK
website/content/en/highlights/2020-02-14-global-log-schema.md: block 1 (line 28) OK
website/content/en/highlights/2020-02-21-file-source-multiline-support.md: block 1 (line 38) OK
website/content/en/highlights/2020-02-24-swimlanes-transform.md: block 1 (line 20) OK
website/content/en/highlights/2020-03-04-encoding-only-fields-except-fields.md: block 1 (line 27) FAILED
  line 27:2: [error] wrong indentation: expected 0 but found 1 (indentation)
  line 30:1: [error] syntax error: expected '<document start>', but found '<block sequence start>' (syntax)
  line 31:1: [error] wrong indentation: expected 5 but found 0 (indentation)
  line 32:1: [error] wrong indentation: expected 5 but found 0 (indentation)
  line 33:1: [error] wrong indentation: expected 5 but found 0 (indentation)
  line 34:1: [error] wrong indentation: expected 5 but found 0 (indentation)
website/content/en/highlights/2020-03-10-dedupe-transform.md: block 1 (line 26) OK
website/content/en/highlights/2020-03-11-tag-cardinality-limit-transform.md: block 1 (line 24) OK
website/content/en/highlights/2020-03-31-filter-transform.md: block 1 (line 24) OK
website/content/en/highlights/2020-04-01-more-condition-predicates.md: block 1 (line 35) OK
website/content/en/highlights/2020-05-27-add-support-for-loading-multiple-cas.md: block 1 (line 19) OK
website/content/en/highlights/2020-07-10-add-reduce-transform.md: block 1 (line 58) OK
website/content/en/highlights/2020-09-18-adaptive-concurrency.md: block 1 (line 29) FAILED
  line 34:5: [warning] comment not indented like content (comments-indentation)
website/content/en/highlights/2020-10-27-metrics-integrations.md: block 1 (line 43) OK
website/content/en/highlights/2020-11-19-prometheus-remote-integrations.md: block 1 (line 35) OK
website/content/en/highlights/2020-11-19-prometheus-remote-integrations.md: block 2 (line 75) OK
website/content/en/highlights/2020-11-25-json-yaml-config-formats.md: no YAML blocks found
website/content/en/highlights/2020-12-23-graphql-api.md: block 1 (line 32) OK
website/content/en/highlights/2020-12-23-internal-logs-source.md: block 1 (line 42) OK
website/content/en/highlights/2021-01-10-kafka-sink-metrics.md: block 1 (line 22) OK
website/content/en/highlights/2021-01-20-wildcard-identifiers.md: block 1 (line 19) OK
website/content/en/highlights/2021-02-16-0-12-upgrade-guide.md: block 1 (line 121) OK
website/content/en/highlights/2021-02-16-filter-remap-support.md: block 1 (line 28) FAILED
  line 44:5: [error] duplication of key "condition" in mapping (key-duplicates)
website/content/en/highlights/2021-04-21-vector-tap.md: block 1 (line 31) OK
website/content/en/highlights/2021-04-21-vrl-abort.md: block 1 (line 32) OK
website/content/en/highlights/2021-07-14-0-15-upgrade-guide.md: block 1 (line 46) OK
website/content/en/highlights/2021-07-14-0-15-upgrade-guide.md: block 2 (line 59) OK
website/content/en/highlights/2021-07-14-0-15-upgrade-guide.md: block 3 (line 73) OK
website/content/en/highlights/2021-07-14-0-15-upgrade-guide.md: block 4 (line 93) OK
website/content/en/highlights/2021-07-14-0-15-upgrade-guide.md: block 5 (line 105) OK
website/content/en/highlights/2021-07-14-0-15-upgrade-guide.md: block 6 (line 119) OK
website/content/en/highlights/2021-07-14-vector-graph.md: block 1 (line 20) OK
website/content/en/highlights/2021-07-16-remap-multiple.md: block 1 (line 24) OK
website/content/en/highlights/2021-07-16-remap-multiple.md: block 2 (line 49) OK
website/content/en/highlights/2021-07-16-remap-multiple.md: block 3 (line 73) OK
website/content/en/highlights/2021-08-20-rate-limits.md: block 1 (line 27) OK
website/content/en/highlights/2021-08-25-0-16-upgrade-guide.md: block 1 (line 34) OK
website/content/en/highlights/2021-08-25-0-16-upgrade-guide.md: block 2 (line 62) OK
website/content/en/highlights/2021-08-25-0-16-upgrade-guide.md: block 3 (line 73) OK
website/content/en/highlights/2021-10-06-arc-default.md: block 1 (line 24) OK
website/content/en/highlights/2021-10-06-arc-default.md: block 2 (line 40) OK
website/content/en/highlights/2021-10-06-source-codecs.md: block 1 (line 21) OK
website/content/en/highlights/2021-10-06-source-codecs.md: block 2 (line 41) OK
website/content/en/highlights/2021-11-12-event-throttle-transform.md: block 1 (line 52) OK
website/content/en/highlights/2021-12-15-splunk-hec-improvements.md: block 1 (line 35) OK
website/content/en/highlights/2021-12-15-splunk-hec-improvements.md: block 2 (line 55) OK
website/content/en/highlights/2021-12-28-0-19-0-upgrade-guide.md: block 1 (line 169) OK
website/content/en/highlights/2022-01-12-vector-unit-test-improvements.md: block 1 (line 17) OK
website/content/en/highlights/2022-02-08-disk-buffer-v2-beta.md: block 1 (line 37) OK
website/content/en/highlights/2022-02-08-disk-buffer-v2-beta.md: block 2 (line 80) FAILED
  line 88:1: [error] duplication of key "sinks" in mapping (key-duplicates)
website/content/en/highlights/2022-03-15-vrl-vm-beta.md: block 1 (line 24) OK
website/content/en/highlights/2022-03-22-0-21-0-upgrade-guide.md: block 1 (line 72) OK
website/content/en/highlights/2022-03-22-0-21-0-upgrade-guide.md: block 2 (line 83) OK
website/content/en/highlights/2022-03-31-native-event-codecs.md: block 1 (line 27) OK
website/content/en/highlights/2022-03-31-native-event-codecs.md: block 2 (line 88) OK
website/content/en/highlights/2022-03-31-native-event-codecs.md: block 3 (line 101) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 1 (line 40) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 2 (line 57) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 3 (line 182) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 4 (line 194) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 5 (line 207) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 6 (line 218) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 7 (line 231) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 8 (line 240) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 9 (line 254) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 10 (line 263) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 11 (line 277) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 12 (line 292) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 13 (line 309) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 14 (line 321) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 15 (line 335) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 16 (line 349) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 17 (line 364) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 18 (line 373) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 19 (line 387) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 20 (line 396) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 21 (line 410) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 22 (line 419) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 23 (line 433) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 24 (line 442) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 25 (line 456) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 26 (line 472) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 27 (line 490) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 28 (line 500) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 29 (line 513) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 30 (line 523) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 31 (line 536) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 32 (line 547) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 33 (line 560) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 34 (line 573) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 35 (line 593) OK
website/content/en/highlights/2022-05-03-0-22-0-upgrade-guide.md: block 36 (line 606) OK
website/content/en/highlights/2022-07-07-0-23-0-upgrade-guide.md: block 1 (line 139) OK
website/content/en/highlights/2022-07-07-0-23-0-upgrade-guide.md: block 2 (line 258) OK
website/content/en/highlights/2022-07-07-0-23-0-upgrade-guide.md: block 3 (line 270) OK
website/content/en/highlights/2022-07-07-0-23-0-upgrade-guide.md: block 4 (line 284) OK
website/content/en/highlights/2022-07-07-0-23-0-upgrade-guide.md: block 5 (line 295) OK
website/content/en/highlights/2022-07-07-0-23-0-upgrade-guide.md: block 6 (line 335) OK
website/content/en/highlights/2022-07-07-0-23-0-upgrade-guide.md: block 7 (line 362) OK
website/content/en/highlights/2022-07-07-0-23-0-upgrade-guide.md: block 8 (line 373) OK
website/content/en/highlights/2022-07-07-0-23-0-upgrade-guide.md: block 9 (line 379) OK
website/content/en/highlights/2022-07-07-0-23-0-upgrade-guide.md: block 10 (line 391) OK
website/content/en/highlights/2022-07-07-0-23-0-upgrade-guide.md: block 11 (line 399) OK
website/content/en/highlights/2022-07-07-0-23-0-upgrade-guide.md: block 12 (line 408) OK
website/content/en/highlights/2022-07-07-secrets-management.md: block 1 (line 23) OK
website/content/en/highlights/2022-07-07-secrets-management.md: block 2 (line 32) OK
website/content/en/highlights/2022-07-07-sink-codecs.md: block 1 (line 24) OK
website/content/en/highlights/2022-10-04-0-25-0-upgrade-guide.md: block 1 (line 71) OK
website/content/en/highlights/2022-10-04-0-25-0-upgrade-guide.md: block 2 (line 148) OK
website/content/en/highlights/2022-10-04-0-25-0-upgrade-guide.md: block 3 (line 160) OK
website/content/en/highlights/2024-07-29-0-40-0-upgrade-guide.md: block 1 (line 40) OK
website/content/en/highlights/2024-07-29-0-40-0-upgrade-guide.md: block 2 (line 52) OK
website/content/en/highlights/2024-07-29-0-40-0-upgrade-guide.md: block 3 (line 77) OK
Fixing yaml blocks inside markdown

Command

git diff --name-only master...HEAD -- '*.md' | xargs uv run scripts/md-yaml.py fix --verbose

Output

(see PR diffs!)

Change Type

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

Is this a breaking change?

  • Yes
  • No

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.

References

Related: #25163

pront and others added 7 commits April 10, 2026 11:12
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>
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>
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>
@bfung bfung changed the title chore(docs): lint yaml inside markdown chore(dev): lint yaml inside markdown Apr 10, 2026
@bfung bfung added no-changelog Changes in this PR do not need user-facing explanations in the release changelog labels Apr 10, 2026
@bfung bfung marked this pull request as ready for review April 10, 2026 20:27
@bfung bfung requested review from a team as code owners April 10, 2026 20:27
@rtrieu rtrieu self-assigned this Apr 10, 2026
Base automatically changed from pavlos/convert-toml-to-yaml-website to master April 13, 2026 16:21
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.

3 participants