-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
docs: Updated Fluent Bit docs to use official plugin + Sandbox #14004
Conversation
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.
[docs team] I'm only partway through this review, but I'm already hopelessly confused as to which plugin we're recommending. The naming conventions don't seem to be consistent between the files. I'm unclear on the difference between "official" and "community" or where you obtain either plugin. And if we're recommending one plugin over the other, why are we documenting both?
If there is some reason to document both, then we should turn the `_index" page into a landing page that briefly explains the difference between the two, and have the two plugin pages and the tutorial as child pages.
Co-authored-by: J Stickler <[email protected]>
Hi @JStickler, I think the PR is ready for another review. I added the index page we discussed in our meeting and did a bit of rewording around how we position each of the plugins. Let me know what you think! |
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.
[docs team]
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Co-authored-by: J Stickler <[email protected]>
Aaah thanks for all the typo catches again @JStickler, classic me. Thats them all accepted and ready for your review. |
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.
[docs team] LGTM
copyedits
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.
[docs team] Thanks for that last little fix. LGTM.
Co-authored-by: J Stickler <[email protected]> (cherry picked from commit 3e451c7)
Co-authored-by: J Stickler <[email protected]> (cherry picked from commit 3e451c7)
Co-authored-by: J Stickler <[email protected]> (cherry picked from commit 3e451c7)
We now recommend using the official Fluent Bit plugin since the Fluent Bit community actively maintains it and is now more feature-rich than the community plugin. The update:
Sandbox preview for testing: https://killercoda.com/grafana-dev-testing/course/loki/fluentbit-loki-tutorial
Note link to the sandbox will fail in docs will fail with a 404 since we have not pushed the sandbox to production
Checklist
CONTRIBUTING.md
guide (required)feat
PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.md
production/helm/loki/Chart.yaml
and updateproduction/helm/loki/CHANGELOG.md
andproduction/helm/loki/README.md
. Example PRdeprecated-config.yaml
anddeleted-config.yaml
files respectively in thetools/deprecated-config-checker
directory. Example PR