Skip to content

Conversation

@esmerel
Copy link

@esmerel esmerel commented Nov 4, 2025

fixing a docs link


Enter [N/A] in the box, if an item is not applicable to your change.

Testing
Before we can approve your change; please submit the following in a comment:

  • Example configuration file for the change
  • Debug log output from testing the change
  • Attached Valgrind output that shows no leaks or memory corruption was found

If this is a change to packaging of containers or native binaries then please confirm it works for all targets.

  • Run local packaging test showing all targets (including any new ones) build.
  • Set ok-package-test label to test for all targets (requires maintainer to do).

Documentation

  • Documentation required for this feature

Backporting

  • Backport to latest stable release.

Fluent Bit is licensed under Apache 2.0, by submitting this pull request I understand that this code will be released under the terms of that license.

Summary by CodeRabbit

  • Documentation
    • Updated documentation reference link for Docker installation guidance.

fixing a docs link

Signed-off-by: Lynette  Miles <[email protected]>
@coderabbitai
Copy link

coderabbitai bot commented Nov 4, 2025

Walkthrough

This pull request updates a documentation reference link in the dockerfiles README file, redirecting it from the manual installation page to the downloads/docker page without affecting any functional code.

Changes

Cohort / File(s) Summary
Documentation Link Update
dockerfiles/README.md
Updated Docker documentation URL from /manual/installation/docker to /manual/installation/downloads/docker

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • patrick-stephens

Poem

🐰 A link was wandering, lost in the docs,
Till we redirected its path with some rocks,
From old installation to downloads so bright,
Now Docker flows smoothly—a reader's delight! 📚✨

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating a documentation link in the README for Docker installation details, which matches the actual change in dockerfiles/README.md.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
dockerfiles/README.md (1)

11-11: Consider wrapping the bare URL per markdown linting standards.

The static analysis tool flagged the bare URL (MD034). Markdown linting prefers URLs to be wrapped in angle brackets <url> or markdown link syntax [text](url). However, note that all other URLs in this file follow the same bare URL pattern, so fixing this inconsistency would require updating lines 15, 23, 28, and 34 as well for consistency.

If you decide to standardize, apply this diff:

-For a detailed list of installation, usage and versions available, please refer to the the official documentation: https://docs.fluentbit.io/manual/installation/downloads/docker
+For a detailed list of installation, usage and versions available, please refer to the the official documentation: <https://docs.fluentbit.io/manual/installation/downloads/docker>
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ed06c31 and 28d8def.

📒 Files selected for processing (1)
  • dockerfiles/README.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-09-14T09:46:09.531Z
Learnt from: aminvakil
Repo: fluent/fluent-bit PR: 10844
File: conf/fluent-bit:13-15
Timestamp: 2025-09-14T09:46:09.531Z
Learning: For fluent-bit Debian packaging, /opt/fluent-bit/bin/ is the appropriate installation path since the package may be installed from non-official Debian sources, making /opt compliant with FHS for optional software packages.

Applied to files:

  • dockerfiles/README.md
🪛 markdownlint-cli2 (0.18.1)
dockerfiles/README.md

11-11: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (2)
dockerfiles/README.md (2)

11-11: Update documentation link to correct Docker installation guide page.

The URL has been correctly updated to point to the more specific Docker downloads documentation page.


11-11: URL verification complete — no issues found.

The URL https://docs.fluentbit.io/manual/installation/downloads/docker exists and contains Docker installation documentation for Fluent Bit, including docker run examples, configuration-file usage, image tags/architectures, signing info, and FAQ. The documentation reference in the README is valid and appropriate.

Copy link
Contributor

@cosmo0920 cosmo0920 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add docs: prefix in your commit message?
This should make failure a workflow of verifying commit messages.

@patrick-stephens patrick-stephens changed the title Update README link for Docker installation details docs: update README link for Docker installation details Nov 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants