merge branch 'lucastemb/site_configuration_field' of github.com:lucastemb/fluent-bit-docs into lucastemb/site_configuration_field

Author: lucastemb

.github/workflows/pr-lint.yaml

@@ -21,3 +21,23 @@ 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).
+  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

.markdownlint.json

@@ -4,6 +4,7 @@
     "MD007": { "indent": 2 },
     "MD013": false,
     "MD025": { "front_matter_title": "false" },
+    "MD047": false,
     "MD049": { "style": "underscore" },
 	"no-hard-tabs": false,
     "whitespace": false,

.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,20 +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"
@@ -154,19 +163,31 @@ 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
 
 [Markdownlint](https://github.com/markdownlint/markdownlint) checks markdown in a
 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.

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