Skip to content

Commit 7e2c8c7

Browse files
committed
docs: fix Vale and markdownlint findings across PR files
Resolve all Vale errors and suggestions in the config example validation PR, plus markdownlint errors in the new scripts README. - scripts/README.md: replace "e.g.," with "for example," (3 instances), convert 5 headings to sentence case, use "aren't" contraction, and fix markdownlint MD031/MD032/MD040 by adding blank lines around fences and lists and switching nested Markdown examples to 4-backtick outer fences - installation/downloads/docker.md: spell out "K8s" as "Kubernetes" - pipeline/inputs/tail.md: use "`inode` numbers" so the term is in code font and skipped by the spelling rule - pipeline/filters/parser.md: use "shouldn't" contraction - pipeline/outputs/kafka.md: use "isn't" contraction - pipeline/parsers.md: remove leading ellipsis and rewrite as a complete sentence Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 8d1ea3b commit 7e2c8c7

6 files changed

Lines changed: 29 additions & 19 deletions

File tree

‎installation/downloads/docker.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ The reasons for using distroless are well covered in
303303
- Reduces false positives on scans (and reduces resources required for scanning).
304304
- Reduces supply chain security requirements to only what you need.
305305
- Helps prevent unauthorised processes or users interacting with the container.
306-
- Less need to harden the container (and container runtime, K8s, and so on).
306+
- Less need to harden the container (and container runtime, Kubernetes, and so on).
307307
- Faster CI/CD processes.
308308

309309
With any choice, there are downsides:

‎pipeline/filters/parser.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The plugin supports the following configuration parameters:
1616
| `parser` | Specify the parser name to interpret the field. Multiple parser entries are allowed (one per line). | _none_ |
1717
| `preserve_key` | Keep the original `key_name` field in the parsed result. If false, the field will be removed. | `false` |
1818
| `reserve_data` | Keep all other original fields in the parsed result. If false, all other original fields will be removed. | `false` |
19-
| `Unescape_key` | Deprecated. This option is retained only for backward compatibility and should not be used in new configurations. | _deprecated_ |
19+
| `Unescape_key` | Deprecated. This option is retained only for backward compatibility and shouldn't be used in new configurations. | _deprecated_ |
2020

2121
## Get started
2222

‎pipeline/inputs/tail.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ systemctl edit fluent-bit.service
167167

168168
When the Linux inotify event queue overflows (indicated by an `IN_Q_OVERFLOW` event), Fluent Bit automatically reconciles all monitored files. During reconciliation it:
169169

170-
- Detects rotated files by comparing inodes and file names and re-registers watches as needed.
170+
- Detects rotated files by comparing `inode` numbers and file names and re-registers watches as needed.
171171
- Resets offset tracking for files that have been truncated.
172172
- Retries watch registration for files that previously failed, for example due to `ENOSPC` when `fs.inotify.max_user_watches` is exhausted.
173173

‎pipeline/outputs/kafka.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ pipeline:
8888

8989
### Avro support
9090

91-
Fluent Bit comes with support for Avro encoding for the `out_kafka` plugin but this is not enabled by default for releases.
91+
Fluent Bit comes with support for Avro encoding for the `out_kafka` plugin but this isn't enabled by default for releases.
9292

9393
Avro support is optional and must be activated at build time by using a build definition with `cmake`: `-DFLB_AVRO_ENCODER=On` such as in the following example which activates:
9494

‎pipeline/parsers.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For example, a parser can turn an unstructured log entry like this:
2222
192.168.2.20 - - [28/Jul/2006:10:27:10 -0300] "GET /cgi-bin/try/ HTTP/1.0" 200 3395
2323
```
2424

25-
...into a structured JSON object like this:
25+
The parser turns that entry into a structured JSON object like this:
2626

2727
```json
2828
{

‎scripts/README.md‎

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
# Documentation Scripts
1+
# Documentation scripts
22

33
This directory contains utility scripts for validating Fluent Bit configuration examples in the documentation.
44

5-
## Configuration Validation
5+
## Configuration validation
66

77
### `test-config.sh`
88

99
Validates all Fluent Bit configuration examples in Markdown files by running them through `fluent-bit --dry-run`.
1010

1111
**Usage:**
12+
1213
```bash
1314
./scripts/test-config.sh <markdown-file>
1415
```
@@ -23,6 +24,7 @@ The script uses a **two-stage approach** to ensure reliable error reporting:
2324
This approach ensures that extraction errors are always legitimate—never due to reaching the end of examples. Any extraction error indicates a genuine problem with the file structure.
2425

2526
**Features:**
27+
2628
- Supports multiple examples per Markdown file (processes all examples)
2729
- Validates both YAML (`fluent-bit.yaml`) and legacy `.conf` (`fluent-bit.conf`) formats
2830
- Reports all validation failures for a file (doesn't stop at first failure)
@@ -31,11 +33,13 @@ This approach ensures that extraction errors are always legitimate—never due t
3133
- Only reports errors that are legitimate (malformed examples or configuration issues)
3234

3335
**Example - validate a single file:**
36+
3437
```bash
3538
./scripts/test-config.sh pipeline/inputs/tail.md
3639
```
3740

3841
**Example - validate all documentation files:**
42+
3943
```bash
4044
find . -type f -iname "*.md" | while read -r file; do
4145
if ! ./scripts/test-config.sh "$file"; then
@@ -49,22 +53,26 @@ done
4953
Extracts Fluent Bit configuration code blocks from Markdown files. This is used internally by `test-config.sh` but can also be called directly.
5054

5155
**Usage:**
56+
5257
```bash
5358
./scripts/extract-config.sh <markdown-file> <tab-title> <fence-language> [index|count]
5459
```
5560

5661
**Parameters:**
62+
5763
- `markdown-file`: Path to the Markdown file
58-
- `tab-title`: The tab title (e.g., `"fluent-bit.yaml"` or `"fluent-bit.conf"`)
59-
- `fence-language`: The code fence language (e.g., `yaml` or `text`)
64+
- `tab-title`: The tab title (for example, `"fluent-bit.yaml"` or `"fluent-bit.conf"`)
65+
- `fence-language`: The code fence language (for example, `yaml` or `text`)
6066
- `index|count` (Optional): Extract a specific example by index, or use `count` to get the total number of examples. Defaults to 1 (first example)
6167

6268
**Features:**
69+
6370
- Automatically removes common leading indentation from extracted examples
64-
- Handles indented tabs in Markdown (e.g., nested within list items or other structures)
71+
- Handles indented tabs in Markdown (for example, nested within list items or other structures)
6572
- Preserves relative indentation within the configuration
6673

6774
**Examples:**
75+
6876
```bash
6977
# Count total YAML examples in a file
7078
./scripts/extract-config.sh pipeline/inputs/tail.md "fluent-bit.yaml" yaml count
@@ -82,21 +90,23 @@ Extracts Fluent Bit configuration code blocks from Markdown files. This is used
8290
**Count mode:**
8391

8492
The `count` parameter returns the total number of matching code fences for the specified language in the given tab. This is used by `test-config.sh` to:
93+
8594
1. Determine how many examples to validate
8695
2. Avoid trying to extract examples that don't exist
8796
3. Ensure all extraction errors are legitimate
8897

8998
Example output:
99+
90100
```bash
91101
$ ./scripts/extract-config.sh pipeline/inputs/tail.md "fluent-bit.yaml" yaml count
92102
5
93103
```
94104

95-
## Markdown Format
105+
## Markdown format
96106

97107
Configuration examples should be formatted using Gitbook-style tabs:
98108

99-
```markdown
109+
````markdown
100110
{% tabs %}
101111
{% tab title="fluent-bit.yaml" %}
102112
```yaml
@@ -111,12 +121,12 @@ service:
111121
```
112122
{% endtab %}
113123
{% endtabs %}
114-
```
124+
````
115125

116126
Multiple examples in the same file are supported:
117127

118-
```markdown
119-
## First Example
128+
````markdown
129+
## First example
120130

121131
{% tabs %}
122132
{% tab title="fluent-bit.yaml" %}
@@ -126,7 +136,7 @@ Multiple examples in the same file are supported:
126136
{% endtab %}
127137
{% endtabs %}
128138

129-
## Second Example
139+
## Second example
130140

131141
{% tabs %}
132142
{% tab title="fluent-bit.yaml" %}
@@ -135,14 +145,14 @@ Multiple examples in the same file are supported:
135145
```
136146
{% endtab %}
137147
{% endtabs %}
138-
```
148+
````
139149

140-
## Suppression List
150+
## Suppression list
141151

142152
Some configuration examples are intentionally skipped in validation. These are configured in the `SUPPRESSED_FILES` array in `test-config.sh`. Files are suppressed if they:
143153

144154
- Require additional plugins not included in the standard container image
145-
- Contain examples that are not yet supported
155+
- Contain examples that aren't yet supported
146156
- Are Windows-specific configurations
147157

148158
Refer to the comments in `test-config.sh` for the complete list and reasons for each suppression.

0 commit comments

Comments
 (0)