Skip to content
11 changes: 11 additions & 0 deletions .github/workflows/pr-lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,14 @@ jobs:
steps:
- uses: actions/checkout@v4
- uses: ludeeus/action-shellcheck@master

markdownlint:
name: runner / markdownlint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: markdownlint
uses: prologic/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
reporter: github-pr-review # Change reporter. (Only `github-pr-check` is supported at the moment).
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,5 +169,9 @@ The following tests are at a `warning` level and won't prevent merging:
file and makes suggestions for improvements. Most markdownlint tests are enabled.
[See the configuration file](https://github.com/fluent/fluent-bit-docs/blob/master/.markdownlint.json).

The Fluent Bit documentation repository is using a GitHub action to check for invalid
markdown based on the configuration file. This action might provide review
suggestions, but doesn't block merging.

Line wrap tests are off due to a GitBook decision that hard wraps the rendered page
on line wraps in the markdown. This leads to rendered pages with awkward line wraps.
2 changes: 1 addition & 1 deletion installation/getting-started-with-fluent-bit.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: A guide on how to install, deploy, and upgrade Fluent Bit

## Container deployment

| Deployment Type | instructions |
| Deployment Type | Instructions |
| ----------------- | -------------------------------------------------- |
| Kubernetes | [Deploy on Kubernetes](kubernetes.md#installation) |
| Docker | [Deploy with Docker](docker.md) |
Expand Down