Summary
Adding code-block linting to the InfluxData docs site (which generates the
published plugin docs from these READMEs) surfaced a set of plugin READMEs whose
fenced code blocks declare a language that doesn't match the content. A few are
genuine errors a reader could copy-paste; most are fence-language mismatches that
produce misleading highlighting and fail JSON validation downstream.
This issue tracks the cleanup. For config blocks, changes are made in each
plugin's sample.conf and the README is regenerated with make docs, per the
guidance on #18830. The single bundled PR #18830 is superseded by the per-plugin
PRs below.
Genuine errors (PRs)
Each fix was verified by loading the config in Telegraf 1.39.1.
Fence-language mismatches (issues)
Related
Summary
Adding code-block linting to the InfluxData docs site (which generates the
published plugin docs from these READMEs) surfaced a set of plugin READMEs whose
fenced code blocks declare a language that doesn't match the content. A few are
genuine errors a reader could copy-paste; most are fence-language mismatches that
produce misleading highlighting and fail JSON validation downstream.
This issue tracks the cleanup. For config blocks, changes are made in each
plugin's
sample.confand the README is regenerated withmake docs, per theguidance on #18830. The single bundled PR #18830 is superseded by the per-plugin
PRs below.
Genuine errors (PRs)
Each fix was verified by loading the config in Telegraf 1.39.1.
//comments are invalid in TOML//comment is invalid in TOMLsensorskey (fixed insample.conf)Fence-language mismatches (issues)
named.confexample fenced asjsonjsonjsontomljsonjsonjsonjsonjsonjsonjavascriptRelated
node_idsexample uses outdated inline-array syntax