Skip to content

Commit

Permalink
Added docs on running the linter
Browse files Browse the repository at this point in the history
  • Loading branch information
reimda committed Apr 14, 2022
1 parent 1ec35dd commit 6db81bd
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions tools/readme_linter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# README.md linter

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

```shell
~/go/src/github.com/influxdata/telegraf$ tools/readme_linter/readme_linter plugins/inputs/file/README.md
```

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

To lint all the plugin readmes:

```shell
~/go/src/github.com/influxdata/telegraf$ tools/readme_linter/readme_linter plugins/*/*/README.md
```

To lint readmes for inputs starting a-d:

```shell
~/go/src/github.com/influxdata/telegraf$ tools/readme_linter/readme_linter plugins/inputs/[a-d]*/README.md
```

0 comments on commit 6db81bd

Please sign in to comment.