consolidate "unit sizes" info into configuration page

[alexakreizinger]

Summary by CodeRabbit

• Documentation
  • Integrated unit sizes into the main Fluent Bit configuration guide and added anchor-based navigation
  • Removed the separate unit-sizes page and updated links to point to the new anchor
  • Renamed several navigation headings for clearer wording (e.g., "YAML configuration" → "YAML configuration files")
  • Streamlined configuration reference content and removed a large embedded help block
  • Minor formatting and wording tweaks across multiple configuration pages

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

This PR consolidates Fluent Bit unit-sizes documentation by moving the standalone unit-sizes page into a Unit Sizes subsection within administration/configuring-fluent-bit.md, updates navigation labels, adds a .gitbook.yaml redirect to the new anchor, and updates links across inputs/filters/outputs to reference the new anchor.

Changes

Cohort / File(s)	Summary
Docs config & redirect \.gitbook.yaml	Added redirect mapping administration/configuring-fluent-bit/unit-sizes → ./administration/configuring-fluent-bit.md#unit-sizes.
Consolidated unit-sizes content administration/configuring-fluent-bit.md, administration/configuring-fluent-bit/unit-sizes.md	Unit-sizes content moved into configuring-fluent-bit.md as an anchored subsection; the standalone unit-sizes.md file removed.
Navigation / naming SUMMARY.md, administration/configuring-fluent-bit/yaml.md, administration/configuring-fluent-bit/classic-mode.md	Renamed navigation labels: "YAML configuration" → "YAML configuration files", "Classic mode" → "Classic configuration files"; removed Unit Sizes entry from SUMMARY.
Minor structural edit administration/configuring-fluent-bit/security.md	Removed top-level "Security" heading.
Pipeline inputs — link updates pipeline/inputs/blob.md, pipeline/inputs/exec-wasi.md, pipeline/inputs/exec.md, pipeline/inputs/forward.md, pipeline/inputs/standard-input.md, pipeline/inputs/tail.md	Updated unit-size links to point to administration/configuring-fluent-bit.md#unit-sizes; small whitespace/format fixes in standard-input.md.
Pipeline filters — link updates pipeline/filters/kubernetes.md, pipeline/filters/wasm.md	Updated unit-size reference links to the new anchor in configuring-fluent-bit.md; minor formatting tweaks.
Pipeline outputs — link updates pipeline/outputs/elasticsearch.md, pipeline/outputs/opensearch.md	Updated Buffer_Size unit-size links to administration/configuring-fluent-bit.md#unit-sizes.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20–30 minutes

• Extra attention areas:
  • Verify all updated relative links correctly resolve to administration/configuring-fluent-bit.md#unit-sizes.
  • Confirm the relocated unit-sizes content fully matches the removed file (no missing examples or clarifications).
  • Check the .gitbook.yaml redirect syntax and path correctness.

Possibly related PRs

• Fixes for linting issues for blob input plugin docs. Applies to #2185. #2191 — Edits pipeline/inputs/blob.md; likely overlaps with link/wording changes applied to the same file.

Poem

🐇 I hopped through docs with ink and delight,
Merged unit sizes to one shining light,
Anchors and redirects now guide every mouse,
The docs found a cozy, consolidated house. ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title directly and accurately reflects the main change: consolidating unit sizes documentation from a separate page into the configuration page as an anchor.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch alexakreizinger/sc-153842/consolidate-unit-sizes-into-configure-fluent

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 332fc84 and 4201748.

📒 Files selected for processing (1)

• administration/configuring-fluent-bit.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

administration/configuring-fluent-bit.md

[grammar] ~21-~21: Use a hyphen to join words.
Context: ...eans 32,000,000,000 bytes. | ## Command line interface Fluent Bit exposes most ...

(QB_NEW_EN_HYPHEN)

---

[grammar] ~23-~23: Use a hyphen to join words.
Context: ...nfiguration features through the command line interface. Use the -h or --help...

(QB_NEW_EN_HYPHEN)

🔇 Additional comments (3)

administration/configuring-fluent-bit.md (3)

3-7: Configuration file introduction is clear and well-organized.

The updated preamble clearly explains the two supported configuration formats with references to the respective detailed pages. No issues identified.

---

8-20: Unit sizes subsection is well-structured and provides comprehensive guidance.

The consolidation of unit-sizes documentation into this central section is effective. The table clearly maps suffixes to their meanings with practical examples. This provides good reference material for configuration parameters.

---

25-31: Docker and Podman examples are appropriate.

The container usage examples for both Podman and Docker tooling are correct and provide clear next steps for users. No issues identified.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (2)

.gitbook.yaml (1)

104-104: Redirect configuration ensures backward compatibility for old unit-sizes page links.

The new redirect entry properly maintains access to unit-sizes content for old references, directing them to the consolidated anchor location in the main configuration page.

If there are external documentation references or links to the old unit-sizes page URL outside this repository, consider adding a deprecation notice or update guide for those sources.

pipeline/inputs/blob.md (1)

16-16: Unit-size links consolidated; minor style improvement suggested.

The mem_buf_limit parameter link has been correctly updated. However, the static analysis tool flagged that three successive sentences begin with "If". Consider varying the sentence structure slightly for improved readability.

Consider restructuring one of the sentences to avoid the repetitive "If" pattern. For example:

- If set to `0`, the buffer limit is disabled. If the plugin has enabled filesystem buffering, this limit won't apply. The value must be according to the [Unit Size](../../administration/configuring-fluent-bit.md#unit-sizes) specification.
+ Set to `0` to disable the buffer limit. When the plugin has enabled filesystem buffering, this limit won't apply. The value must be according to the [Unit Size](../../administration/configuring-fluent-bit.md#unit-sizes) specification.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2e9c9f1 and 332fc84.

📒 Files selected for processing (17)

• .gitbook.yaml (1 hunks)
• SUMMARY.md (2 hunks)
• administration/configuring-fluent-bit.md (1 hunks)
• administration/configuring-fluent-bit/classic-mode.md (1 hunks)
• administration/configuring-fluent-bit/security.md (0 hunks)
• administration/configuring-fluent-bit/unit-sizes.md (0 hunks)
• administration/configuring-fluent-bit/yaml.md (1 hunks)
• pipeline/filters/kubernetes.md (1 hunks)
• pipeline/filters/wasm.md (3 hunks)
• pipeline/inputs/blob.md (1 hunks)
• pipeline/inputs/exec-wasi.md (1 hunks)
• pipeline/inputs/exec.md (1 hunks)
• pipeline/inputs/forward.md (1 hunks)
• pipeline/inputs/standard-input.md (5 hunks)
• pipeline/inputs/tail.md (1 hunks)
• pipeline/outputs/elasticsearch.md (1 hunks)
• pipeline/outputs/opensearch.md (1 hunks)

💤 Files with no reviewable changes (2)

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

🧰 Additional context used

🪛 LanguageTool

administration/configuring-fluent-bit.md

[grammar] ~21-~21: Use a hyphen to join words.
Context: ...eans 32,000,000,000 bytes. | ## Command line interface Fluent Bit exposes most ...

(QB_NEW_EN_HYPHEN)

---

[grammar] ~23-~23: Use a hyphen to join words.
Context: ...nfiguration features through the command line interface. Use the -h or --help...

(QB_NEW_EN_HYPHEN)

pipeline/inputs/blob.md

[style] ~16-~16: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t to 0, the buffer limit is disabled. If the plugin has enabled filesystem buffe...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🔇 Additional comments (14)

administration/configuring-fluent-bit/yaml.md (1)

1-1: Header update aligns with documentation scope clarification.

The header change from "YAML configuration" to "YAML configuration files" provides clearer context and aligns with terminology standardization across the documentation.

administration/configuring-fluent-bit/classic-mode.md (1)

1-1: Header update maintains consistent terminology with YAML configuration page.

The header aligns the naming convention with the updated YAML configuration files header, improving the overall documentation terminology.

administration/configuring-fluent-bit.md (1)

3-20: Content consolidation approach is well-executed.

The new subsection effectively consolidates unit-size documentation with a clear table, practical examples, and proper links to affected input plugins. The consolidation maintains backward compatibility via the GitBook redirect configuration.

Verify that all documentation links pointing to the old /administration/configuring-fluent-bit/unit-sizes path have been updated to use the new anchor #unit-sizes, or confirm the GitBook redirect is configured to handle old links.

pipeline/inputs/exec.md (1)

27-27: Link path correctly updated to new unit-sizes anchor location.

The Buf_Size parameter reference now points to the consolidated unit-sizes subsection in the main configuration page with proper relative path and anchor.

pipeline/inputs/tail.md (1)

14-14: Link path correctly updated to new unit-sizes anchor location.

The Buffer_Max_Size parameter reference now points to the consolidated unit-sizes subsection with proper relative path and anchor notation.

pipeline/filters/kubernetes.md (1)

28-28: Link path correctly updated to new unit-sizes anchor location.

The Buffer_Size parameter reference now points to the consolidated unit-sizes subsection with proper relative path and anchor notation.

pipeline/outputs/opensearch.md (1)

18-18: Link path correctly updated to new unit-sizes anchor location.

The Buffer_Size parameter reference now points to the consolidated unit-sizes subsection with proper relative path and anchor notation, consistent with other plugin documentation updates.

pipeline/outputs/elasticsearch.md (1)

19-19: Link consolidation looks good.

The unit-size reference has been consistently updated to point to the new anchor location. The link structure and context are appropriate.

SUMMARY.md (1)

41-41: Navigation labels improved for clarity.

The renamed items ("YAML configuration files" and "Classic configuration files") better describe the target content. File paths remain unchanged, so navigation will continue to function correctly.

Also applies to: 50-50

pipeline/inputs/exec-wasi.md (1)

16-18: Unit-size references consolidated consistently.

All three Wasm-related size parameters now reference the unified anchor location. Links are structurally correct for the file's location.

pipeline/inputs/forward.md (1)

15-16: Buffer-related size references updated consistently.

Both buffer parameters now point to the unified anchor. Link structure is correct.

pipeline/filters/wasm.md (1)

25-26: Wasm size parameters linked to unified anchor.

Both Wasm_Heap_Size and Wasm_Stack_Size now reference the consolidated unit-sizes documentation. Links are correctly structured.

pipeline/inputs/standard-input.md (1)

18-18: Buffer size reference consolidated correctly.

The Buffer_Size parameter now links to the unified unit-sizes anchor. Link path is appropriate for this file location.

pipeline/inputs/blob.md (1)

19-19: Scan refresh interval reference updated consistently.

The scan_refresh_interval parameter now links to the unified anchor location. Link structure is correct.