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

Documentation nitpicks #1196

Closed
HereComesTheMoon opened this issue Sep 18, 2023 · 5 comments
Closed

Documentation nitpicks #1196

HereComesTheMoon opened this issue Sep 18, 2023 · 5 comments
Labels

Comments

@HereComesTheMoon
Copy link

HereComesTheMoon commented Sep 18, 2023

I'm currently reading up on Fluentbit and noticed the following minor issues while reading up on it in the documentation. I put them here for your consideration. I might find other ones later.

  1. Here it claims that "YAML configuration is tech preview so not recommended for production.", but here there is the claim that "YAML configuration feature was introduced since FLuent Bit version 1.9 as experimental, and it is production ready since Fluent Bit 2.0."
  2. This page claims that "Multiple keys with the same name can exist." It's unclear how these are handled—even a short sentence explaining this would be valuable.
  3. https://docs.fluentbit.io/manual/administration/configuring-fluent-bit/classic-mode/format-schema and https://docs.fluentbit.io/manual/administration/configuring-fluent-bit/classic-mode/configuration-file use the same key names (eg. daemon, log_level), but there doesn't appear to be any mention of case sensitivity on either page. This is confusing. This is especially bad when combined with the 'multiple keys' thing. If I define log_level and Log_Level, do I define two different keys or the same one twice?

Have a great week.

@lecaros
Copy link
Contributor

lecaros commented Sep 21, 2023

Hello @HereComesTheMoon,
thanks for reporting this.
Would you like to submit a PR for these?

@endersonmaia
Copy link
Contributor

PR sent for 1. at #1201

@HereComesTheMoon
Copy link
Author

I'd like that, but I'd have to discuss the legalities of the matter with my current employer. I'm fairly new, and we have rules related to open source, so I'd have to figure that out first.

Copy link

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 5 days. Maintainers can add the exempt-stale label.

@github-actions github-actions bot added the Stale label Dec 21, 2023
Copy link

This issue was closed because it has been stalled for 5 days with no activity.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Dec 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants