diff --git a/.github/workflows/pr-lint.yaml b/.github/workflows/pr-lint.yaml index 0fc492b31..643ce6b7f 100644 --- a/.github/workflows/pr-lint.yaml +++ b/.github/workflows/pr-lint.yaml @@ -22,6 +22,16 @@ jobs: - 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/action-markdownlint@v0.26.2 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + reporter: github-pr-review # Change reporter. (Only `github-pr-check` is supported at the moment). vale: name: runner / vale runs-on: ubuntu-latest diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65a7fdb2b..f4a019db6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -185,5 +185,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. diff --git a/installation/getting-started-with-fluent-bit.md b/installation/getting-started-with-fluent-bit.md index 5d2d84e35..f7bcad2fd 100644 --- a/installation/getting-started-with-fluent-bit.md +++ b/installation/getting-started-with-fluent-bit.md @@ -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) |