Skip to content
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

Merged
merged 51 commits into from
Oct 15, 2024

Conversation

Jayclifford345
Copy link
Contributor

@Jayclifford345 Jayclifford345 commented Aug 29, 2024

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:

  • Moved community plugin to its own page for users still using the community plugin
  • Updated _index to give examples using the official fluent bit plugin
  • Added interactive sandbox

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

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@Jayclifford345 Jayclifford345 requested a review from a team as a code owner August 29, 2024 14:43
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Aug 29, 2024
Copy link
Contributor

@JStickler JStickler left a 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.

docs/sources/send-data/fluentbit/_index.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/_index.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/_index.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/_index.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/_index.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/_index.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/_index.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/_index.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/_index.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/community-plugin.md Outdated Show resolved Hide resolved
@Jayclifford345
Copy link
Contributor Author

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!

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team]

docs/sources/send-data/fluentbit/community-plugin.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/community-plugin.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/community-plugin.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/community-plugin.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/community-plugin.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/fluent-bit-plugin.md Outdated Show resolved Hide resolved
@Jayclifford345
Copy link
Contributor Author

Aaah thanks for all the typo catches again @JStickler, classic me. Thats them all accepted and ready for your review.

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] LGTM

docs/sources/send-data/fluentbit/community-plugin.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/community-plugin.md Outdated Show resolved Hide resolved
docs/sources/send-data/fluentbit/fluent-bit-plugin.md Outdated Show resolved Hide resolved
Copy link
Contributor

@JStickler JStickler left a 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.

@JStickler JStickler merged commit 3e451c7 into main Oct 15, 2024
61 checks passed
@JStickler JStickler deleted the fluentbit-docs-changes branch October 15, 2024 13:06
loki-gh-app bot pushed a commit that referenced this pull request Oct 15, 2024
loki-gh-app bot pushed a commit that referenced this pull request Oct 15, 2024
loki-gh-app bot pushed a commit that referenced this pull request Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.0.x backport release-3.1.x backport release-3.2.x size/XL type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants