update kafka datasource documentation for new batch parameters #781
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
remove this, it was an attempt to precise type since we're missing integer/duration/etc in the config but it's not present in any other datasource docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi!
Following the update to the Kafka datasource in this PR: https://github.com/crowdsecurity/crowdsec/pull/3621/files, I'm contributing to the documentation to reflect the new configuration options.
Since the implementation uses kafka-go, I thought it might be helpful to include the default values from the library so users know what happens when they don't explicitly set a parameter.
I haven’t seen other datasources documenting defaults, so I’m not 100% sure about the preferred formatting for this kind of info. Happy to adjust based on your feedback :)