History

reimda 622815c4a2 chore: add readme linter to CI (#11020 )		2022-05-23 13:03:28 -06:00
..
README.md	chore: add readme linter (#10916 )	2022-04-19 11:59:25 -06:00
assert.go	chore: add readme linter to CI (#11020 )	2022-05-23 13:03:28 -06:00
main.go	chore: add readme linter to CI (#11020 )	2022-05-23 13:03:28 -06:00
plugin.go	chore: add readme linter (#10916 )	2022-04-19 11:59:25 -06:00
rules.go	chore: add readme linter (#10916 )	2022-04-19 11:59:25 -06:00
set.go	chore: add readme linter (#10916 )	2022-04-19 11:59:25 -06:00

README.md linter

Building

telegraf/tools/readme_linter$ go build .

Run readme_linter with the filenames of the readme files you want to lint.

telegraf/tools/readme_linter$ ./readme_linter <path to readme>

You can lint multiple filenames at once. This works well with shell globs.

To lint all the plugin readmes:

telegraf/tools/readme_linter$ ./readme_linter ../../plugins/*/*/README.md

To lint readmes for inputs starting a-d:

telegraf/tools/readme_linter$ ./readme_linter ../../plugins/inputs/[a-d]*/README.md