[Documentation] Add a reference page / cookbook of common concurrency operations
Open
Nobody has claimed this yet.
documentation
good first issue
help wanted
- Dominant language
- Scala
- Stars
- 2.5k
- Forks
- 636
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 7
Description
It should cover when you'd use and how to use:
- parEvalMap/Unordered
- parJoin
- concurrently
- merge*
There's the page on Queue/Topic/etc but there's not a great single page on the operations directly on Stream. The Guide section on concurrency is very short and doesn't cover some of the most common operations (parEvalMap especially)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing Guide section on concurrency and the Queue/Topic documentation, then review how Stream operations are documented elsewhere. Add a single reference or cookbook page covering when and how to use parEvalMap/Unordered, parJoin, concurrently, and merge*. Done means the common Stream concurrency operations are explained with practical usage guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100