Merge branch 'master' into lynettemiles/sc-142988/ci-cd-for-fluent-markdownlint

Signed-off-by: Lynette  Miles <[email protected]>

Author: esmerel

.github/workflows/pr-lint.yaml

@@ -32,3 +32,12 @@ jobs:
         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
+    steps:
+      - uses: actions/checkout@v4
+      - uses: errata-ai/[email protected]
+        with:
+          files: all
+          fail_on_error: true

.vale.ini

@@ -5,7 +5,7 @@ IgnoredScopes = tt, code
 [formats]
 mdx = md
 
-[*.{md,markdown,txt,htm,html}]
+[*.{md,markdown}]
 BasedOnStyles = FluentBit
 
 FluentBit.Terms = YES

CONTRIBUTING.md

@@ -42,7 +42,7 @@ within a few minutes.
 If you open a pull request that requires ongoing discussion or review, the Fluent Bit
 maintainers will add a `waiting-for-user` to your pull request. This tag means that
 we're blocked from moving forward until you reply. To keep contributions from going
-stale, we'll wait 45 days for your response, but we may close the pull request if we
+stale, we'll wait 45 days for your response, but we might close the pull request if we
 don't hear back from you by then.
 
 ## Submit a contribution
@@ -132,21 +132,29 @@ the prose of your pull requests and adds suggestions to improve style and clarit
 There is a [VSCode plugin for Vale](https://marketplace.visualstudio.com/items?itemName=ChrisChinchilla.vale-vscode)
 which outputs suggestions to the problems pane in the IDE.
 
+The Fluent Bit repository runs Vale as a GitHub Action on updated text in new pull
+requests. Vale suggestions, errors, and warnings will display in GitHub on the
+**Files changed** page.
+
 [See the Vale tests for Fluent Bit](https://github.com/fluent/fluent-bit-docs/tree/master/vale-styles).
 
 Most Vale tests are at the `suggestion` level and won't block merging.
 
-The following tests are at a `error` level and will prevent merging:
+The following tests are at `error` level and will cause a test failure:
 
 - [AmSpelling](https://developers.google.com/style/word-list)
 - [Ampersand](https://developers.google.com/style/word-list#ampersand)
+- [Don'tUse](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/DontUse.yml)
 - [Emdash](https://github.com/errata-ai/Google/blob/master/Google/EmDash.yml)
 - [Endash](https://github.com/errata-ai/Google/blob/master/Google/EmDash.yml)
 - [Exclamation](https://github.com/errata-ai/Google/blob/master/Google/Exclamation.yml)
 - [Gender](https://developers.google.com/style/pronouns#gender-neutral-pronouns)
 - [GenderBias](https://developers.google.com/style/inclusive-documentation)
+- [Hints](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/Hints.yml) using `>`.
 - [HeadingPunctuation](https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings)
+- [Latin](https://developers.google.com/style/abbreviations)
 - [LyHyphens](https://developers.google.com/style/hyphens)
+- [MayMightCan](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/MayMightCan.yml)
 - [NonStandardQuotes](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/NonStandardQuotes.yml):
   [Use standard quotes](https://developers.google.com/style/quotation-marks#straight-and-curly-quotation-marks).
   By default, Google Docs and Microsoft Word turn standard straight quotes into "smart"
@@ -155,13 +163,21 @@ The following tests are at a `error` level and will prevent merging:
   in [Google Docs](https://support.google.com/docs/thread/217182974/can-i-turn-smart-quotes-off-in-a-google-doc?hl=en)
   or [Microsoft Word](https://support.microsoft.com/en-us/office/smart-quotes-in-word-and-powerpoint-702fc92e-b723-4e3d-b2cc-71dedaf2f343)
   to prevent this problem.
+- [Optional plurals](https://developers.google.com/style/plurals-parentheses)
 - [Ordinal](https://developers.google.com/style/numbers)
+- [Periods](https://developers.google.com/style/abbreviations)
+- [Ranges](https://developers.google.com/style/hyphens)
 - [Repetition](https://github.com/errata-ai/vale/blob/v3/testdata/styles/Markup/Repetition.yml):
   Checks for the same word used twice in succession.
+- [Slang](https://developers.google.com/style/abbreviations)
+- [Spacing](https://developers.google.com/style/sentence-spacing)
 
 The following tests are at a `warning` level and won't prevent merging:
 
 - [Ampersand](https://developers.google.com/style/word-list#ampersand)
+- [First person](https://developers.google.com/style/pronouns#personal-pronouns)
+- [Possessives](https://developers.google.com/style/possessives)
+- [Simplicity](https://developers.google.com/style/word-list#easy)
 
 ### Markdownlint
 

MAINTAINERS.md

@@ -1,6 +1,6 @@
 # Fluent Bit Documentation Maintainers
 
-Fluent Bit is developed and supported by many individuals and companies.  The following table list the names of maintainers per components and the company supporting their work.
+Fluent Bit is developed and supported by many individuals and companies. The following table list the names of maintainers per components and the company supporting their work.
 
 | Maintainer Name                                        | Documentation portion    | Company                                           |
 | :----------------------------------------------------  | ------------------------ | ------------------------------------------------- |
@@ -11,4 +11,3 @@ Fluent Bit is developed and supported by many individuals and companies.  The fo
 | [Alexa Kreizinger](https://github.com/alexakreizinger) | All                      | [Chronosphere](https://chronosphere.io)           |
 | [Paige Cruz](https://github.com/paigerduty)            | All                      | [Chronosphere](https://chronosphere.io/)          |
 | [Eric D. Schabell](https://github.com/eschabell)       | All                      | [Chronosphere](https://chronosphere.io/)          |
-

README.md

@@ -24,7 +24,7 @@ description: High Performance Telemetry Agent for Logs, Metrics and Traces
   - Connect nearly any source to nearly any destination using preexisting plugins
   - Extensibility:
     - Write input, filter, or output plugins in the C language
-    - WASM: [WASM Filter Plugins](development/wasm-filter-plugins.md) or [WASM Input Plugins](development/wasm-input-plugins.md)
+    - Wasm: [Wasm Filter Plugins](development/wasm-filter-plugins.md) or [Wasm Input Plugins](development/wasm-input-plugins.md)
     - Write [Filters in Lua](pipeline/filters/lua.md) or [Output plugins in Golang](development/golang-output-plugins.md)
 - [Monitoring](administration/monitoring.md): Expose internal metrics over HTTP in JSON and [Prometheus](https://prometheus.io/) format
 - [Stream Processing](stream-processing/introduction.md): Perform data selection and transformation using simple SQL queries

SUMMARY.md

@@ -98,7 +98,7 @@
   * [Docker events](pipeline/inputs/docker-events.md)
   * [Docker metrics](pipeline/inputs/docker-metrics.md)
   * [Dummy](pipeline/inputs/dummy.md)
-  * [Ebpf](pipeline/inputs/ebpf.md)
+  * [eBPF](pipeline/inputs/ebpf.md)
   * [Elasticsearch](pipeline/inputs/elasticsearch.md)
   * [Exec WASI](pipeline/inputs/exec-wasi.md)
   * [Exec](pipeline/inputs/exec.md)

administration/configuring-fluent-bit/unit-sizes.md

@@ -1,6 +1,6 @@
 # Unit sizes
 
-Some configuration directives in [Fluent Bit](http://fluentbit.io) refer to unit sizes such as when defining the size of a buffer or specific limits. Plugins like [Tail Input](../../pipeline/inputs/tail), [Forward Input](../../pipeline/inputs/forward.md) or generic properties like [`Mem_Buf_Limit`](../backpressure) use unit sizes.
+Some configuration directives in [Fluent Bit](http://fluentbit.io) refer to unit sizes such as when defining the size of a buffer or specific limits. Plugins like [Tail Input](../../pipeline/inputs/tail.md), [Forward Input](../../pipeline/inputs/forward.md), or generic properties like [`Mem_Buf_Limit`](../backpressure.md) use unit sizes.
 
 Fluent Bit v0.11.10 standardized unit sizes across the core and plugins. The following table describes the options that can be used and what they mean:
 

administration/configuring-fluent-bit/yaml/configuration-file.md

@@ -4,7 +4,8 @@ description: Learn about the YAML configuration file used by Fluent Bit
 
 # YAML configuration file
 
-<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=864c6f0e-8977-4838-8772-84416943548e" />
+<img referrerpolicy="no-referrer-when-downgrade"
+src="https://static.scarf.sh/a.png?x-pxid=864c6f0e-8977-4838-8772-84416943548e" alt="" />
 
 One of the ways to configure Fluent Bit is using a YAML configuration file that works at a global scope.
 

concepts/data-pipeline/parser.md

@@ -26,7 +26,7 @@ The parser converts unstructured data to structured data. As an example, conside
 192.168.2.20 - - [28/Jul/2006:10:27:10 -0300] "GET /cgi-bin/try/ HTTP/1.0" 200 3395
 ```
 
-This log line is a raw string without format. Structuring the log makes it easier to process the data later. If the [regular expression parser](../../pipeline/parsers/regular-expression) is used, the log entry could be converted to:
+This log line is a raw string without format. Structuring the log makes it easier to process the data later. If the [regular expression parser](../../pipeline/parsers/regular-expression.md) is used, the log entry could be converted to:
 
 ```javascript
 {

local-testing/validating-your-data-and-structure.md

@@ -4,7 +4,7 @@ Fluent Bit supports multiple sources and formats. In addition, it provides filte
 
 Fluent Bit users are encouraged to integrate data validation in their continuous integration (CI) systems.
 
-In a normal production environment, inputs, filters, and outputs are defined in configuration files. Fluent Bit provides the [Expect](../pipeline/filters/expect) filter, which you can use to validate keys and values from your records and take action when an exception is found.
+In a normal production environment, inputs, filters, and outputs are defined in configuration files. Fluent Bit provides the [Expect](../pipeline/filters/expect.md) filter, which you can use to validate keys and values from your records and take action when an exception is found.
 
 A simplified view of the data processing pipeline is as follows:
 
@@ -20,8 +20,8 @@ IS --> Fil --> OD
 
 Consider the following pipeline, which uses a JSON file as its data source and has two filters:
 
-- [Grep](../pipeline/filters/grep) to exclude certain records.
-- [Record Modifier](../pipeline/filters/record-modifier) to alter records' content by adding and removing specific keys.
+- [Grep](../pipeline/filters/grep.md) to exclude certain records.
+- [Record Modifier](../pipeline/filters/record-modifier.md) to alter records' content by adding and removing specific keys.
 
 ```mermaid
 flowchart LR
@@ -37,7 +37,7 @@ record --> stdout
 
 Add data validation between each step to ensure your data structure is correct.
 
-This example uses the [Expect](../pipeline/filters/expect) filter.
+This example uses the [Expect](../pipeline/filters/expect.md) filter.
 
 ```mermaid
 flowchart LR
@@ -164,7 +164,7 @@ The following is the Fluent Bit classic parsers file:
 {% endtab %}
 {% endtabs %}
 
-If the JSON parser fails or is missing in the [Tail](../pipeline/inputs/tail) input (`parser json`), the Expect filter triggers the `exit` action.
+If the JSON parser fails or is missing in the [Tail](../pipeline/inputs/tail.md) input (`parser json`), the Expect filter triggers the `exit` action.
 
 To extend the pipeline, add a Grep filter to match records that map `label` containing a key called `name` with value the `abc`, and add an Expect filter to re-validate that condition: