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: Reference build and install from README #8990

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

matschaffer-roblox
Copy link

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

Related to #6003 (comment)

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.

@patrick-stephens
Copy link
Contributor

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

@matschaffer-roblox matschaffer-roblox force-pushed the discussions-6003-doc-cleanup branch from 22fe6fd to 6db915b Compare June 23, 2024 21:35
@matschaffer-roblox matschaffer-roblox force-pushed the discussions-6003-doc-cleanup branch from 6db915b to 2af08b0 Compare June 23, 2024 21:36
@matschaffer-roblox
Copy link
Author

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

@matschaffer-roblox matschaffer-roblox changed the title Reference build and install from README docs: Reference build and install from README Jul 2, 2024
@matschaffer-roblox
Copy link
Author

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
Copy link
Author

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

Copy link
Contributor

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 github-actions bot added the Stale label Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants