fluent-bit icon indicating copy to clipboard operation
fluent-bit copied to clipboard

docs: Reference build and install from README

Open matschaffer-roblox opened this issue 1 year ago • 5 comments

Replaces the somewhat-incomplete build instructions from the main README with a link to the official documentation.

Related to https://github.com/fluent/fluent-bit/discussions/6003#discussioncomment-9789212

When I saw the docs in the readme, I tried to apply them directly, but they don't work on macos without some additional homebrew packages.

The official docs (especially https://docs.fluentbit.io/manual/installation/macos#install-build-dependencies) make this much clearer.


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:

  • [N/A] Example configuration file for the change
  • [N/A] Debug log output from testing the change
  • [N/A] 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.

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

Documentation

  • [N/A] Documentation required for this feature

Backporting

  • [N/A] 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.

matschaffer-roblox avatar Jun 21 '24 01:06 matschaffer-roblox

Can you sort the DCO @matschaffer-roblox as it's required to merge I'm afraid?

patrick-stephens avatar Jun 21 '24 13:06 patrick-stephens

@patrick-stephens looks like I should be set on DCO. Let me know if you need anything else.

matschaffer-roblox avatar Jul 01 '24 19:07 matschaffer-roblox

Thanks @patrick-stephens ! I'm not entirely sure but seems like the commit message checker might have been flagging the PR subject so I updated it to match ^[a-z0-9A-Z\-_\s\,\.\/]+\:[ ]{0,1}[a-zA-Z]+[a-zA-Z0-9 \-\.\:_\#\(\)=\/'\"\,><\+\[\]\!\*\\]+$ - I think you probably have to re-run on your end.

matschaffer-roblox avatar Jul 02 '24 19:07 matschaffer-roblox

👋 was just checking on open PRs and thought I'd bump this.

matschaffer-roblox avatar Jul 28 '24 20:07 matschaffer-roblox

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.

github-actions[bot] avatar Dec 15 '24 02:12 github-actions[bot]

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.

github-actions[bot] avatar Sep 06 '25 02:09 github-actions[bot]