confluentinc / confluentinc/parallel-consumer
Add explanation of close modes to documentation
Open
Beginner friendly
documentation
- Dominant language
- Java
- Stars
- 299
- Forks
- 172
- PR merge metrics
- No merged PRs in 30d
Description
Parallel Consumer has two shutdown modes - with draining and without - add explanation of those to documentation along with timeout options and how they apply.
Contributor guide
No contributing guide indexed for this repository
Research direction
Locate the existing documentation for consumer shutdown or close behavior, then read the relevant Java API definitions for the two shutdown modes and timeout options. Document draining and non-draining shutdown, including how the timeout settings apply; done means both modes and their timeout behavior are explained clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, kafka
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100