consolidate install/platforms/requirements info #2172
Conversation
Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
|
Caution Review failedThe pull request is closed. WalkthroughRemoved two installation pages and consolidated their content into Changes
Sequence Diagram(s)sequenceDiagram
participant User as User (Docs)
participant Redirect as Redirects (.gitbook.yaml)
participant New as installation/downloads.md
Note over User,New: Before — multiple installation pages existed
User->>New: Request /installation/downloads.md
New-->>User: Serve consolidated downloads page
Note right of Redirect: After — old URLs redirected
User->>Redirect: Request /installation/getting-started-with-fluent-bit (or /requirements /supported-platforms)
Redirect-->>New: Forward to `installation/downloads.md`
New-->>User: Serve consolidated downloads page
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
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. Comment |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
installation/downloads.md (1)
64-64: Consider spelling out "CVE" acronym.Line 64 mentions "CVE backporting" but does not define the acronym. For readers unfamiliar with the term, consider spelling it out as "Common Vulnerabilities and Exposures (CVE) backporting" on first mention.
Apply this diff to improve clarity:
-Fluent Bit packages are also provided by [enterprise providers](https://fluentbit.io/enterprise) for older end-of-life versions, Unix systems, or for additional support and features including aspects (such as CVE backporting). +Fluent Bit packages are also provided by [enterprise providers](https://fluentbit.io/enterprise) for older end-of-life versions, Unix systems, or for additional support and features including aspects (such as Common Vulnerabilities and Exposures (CVE) backporting).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
.gitbook.yaml(1 hunks)SUMMARY.md(0 hunks)installation/downloads.md(1 hunks)installation/getting-started-with-fluent-bit.md(0 hunks)installation/requirements.md(0 hunks)
💤 Files with no reviewable changes (3)
- installation/requirements.md
- SUMMARY.md
- installation/getting-started-with-fluent-bit.md
🧰 Additional context used
🪛 GitHub Check: runner / vale
installation/downloads.md
[warning] 64-64:
[vale] reported by reviewdog 🐶
[FluentBit.Acronyms] Spell out 'CVE', if it's unfamiliar to the audience.
Raw Output:
{"message": "[FluentBit.Acronyms] Spell out 'CVE', if it's unfamiliar to the audience.", "location": {"path": "installation/downloads.md", "range": {"start": {"line": 64, "column": 210}}}, "severity": "INFO"}
[warning] 15-15:
[vale] reported by reviewdog 🐶
[FluentBit.Spelling] Spelling check: 'Libyaml'?
Raw Output:
{"message": "[FluentBit.Spelling] Spelling check: 'Libyaml'?", "location": {"path": "installation/downloads.md", "range": {"start": {"line": 15, "column": 3}}}, "severity": "INFO"}
🪛 LanguageTool
installation/downloads.md
[uncategorized] ~21-~21: The operating system from Apple is written “macOS”.
Context: ...uilding Fluent Bit from source on macOS and [Windows](../i...
(MAC_OS)
[uncategorized] ~50-~50: The operating system from Apple is written “macOS”.
Context: ...macOS Fluent Bit is available on macOS. ### Windows Fluent Bit is available...
(MAC_OS)
🔇 Additional comments (3)
installation/downloads.md (3)
8-17: Requirements section consolidation looks good.The merged requirements are clear and actionable, and noting the optional nature of certain dependencies (line 17) provides helpful context for users.
1-60: Effective consolidation with clear organization.The new structure successfully combines installation guidance, build prerequisites, and platform coverage into a logical, narrative flow. The removal of version matrices (per PR objectives) simplifies maintenance while the added context about platform support (lines 6, 56–60) provides necessary scope clarification. The tracking pixel relocation (line 4) is in place.
19-21: All internal link references verified as correct.All referenced installation guide files exist, and the section anchors are correctly established through the "## Compile from source" headings in both
installation/downloads/macos.md(line 25) andinstallation/downloads/windows.md(line 309). The links../installation/downloads/macos#compile-from-sourceand../installation/downloads/windows#compile-from-sourceare valid.
Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
…ges-and-supported-platforms Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
alexakreizinger
deleted the
alexakreizinger/sc-146101/fb-combine-packages-and-supported-platforms
branch
this PR consolidates redundant info by combining all of the "here are links to installation guides" info in one place.
a few things of note:
Summary by CodeRabbit