Skip to content

Commit 1d6e8d9

Browse files
committed
Markdownlint addition to contributing.md
Signed-off-by: Lynette Miles <[email protected]>
1 parent 9310d6e commit 1d6e8d9

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,5 +169,9 @@ The following tests are at a `warning` level and won't prevent merging:
169169
file and makes suggestions for improvements. Most markdownlint tests are enabled.
170170
[See the configuration file](https://github.com/fluent/fluent-bit-docs/blob/master/.markdownlint.json).
171171

172+
The Fluent Bit documentation repository is using a GitHub action to check for invalid
173+
markdown based on the configuration file. This action might provide review
174+
suggestions, but doesn't block merging.
175+
172176
Line wrap tests are off due to a GitBook decision that hard wraps the rendered page
173177
on line wraps in the markdown. This leads to rendered pages with awkward line wraps.

0 commit comments

Comments
 (0)