-
Notifications
You must be signed in to change notification settings - Fork 1.8k
docs: update README link for Docker installation details #11106
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
fixing a docs link Signed-off-by: Lynette Miles <[email protected]>
WalkthroughThis 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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 |
There was a problem hiding this 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
📒 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.
cosmo0920
left a comment
There was a problem hiding this 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.
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:
If this is a change to packaging of containers or native binaries then please confirm it works for all targets.
ok-package-testlabel to test for all targets (requires maintainer to do).Documentation
Backporting
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