akka/akka-core

Additional stream operators to include in overview

Open

#25,467 opened on Aug 13, 2018

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Scala (3,547 forks)batch import
1 - triagedgood first issuehackathonhelp wantedt:docst:stream

Repository metrics

Stars
 (13,277 stars)
PR merge metrics
 (Avg merge 8d 19h) (10 merged PRs in 30d)

Description

There are a number of stream operators not yet documented at https://doc.akka.io/docs/akka/current/stream/operators/index.html .

The most current list of not-yet-documented operators can be found at https://github.com/akka/akka/blob/master/project/StreamOperatorsIndexGenerator.scala#L78 . Some probably can remain undocumented, those should be moved to the 'ignore list at https://github.com/akka/akka/blob/master/project/StreamOperatorsIndexGenerator.scala#L121

To document an operator:

  • Optionally, add a comment to this issue 'claiming' the operator
  • Remove it from the 'pending' list
  • Add the markdown file to /akka-docs/src/main/paradox/stream/operators. The convention is Classname/operatorname.md, with the exception of operators that are available on both Sources and Flows. Look at the other files for examples.
  • run sbt paradox to test generating the documentation

Contributor guide

Research direction
Review existing documented operators in the /akka docs/src/main/paradox/stream/operators directory as examples. Then select an undocumented operator from the pending list in project/StreamOperatorsIndexGenerator.scala and follow the steps to add a markdown file.
Tech stack
scala
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaGitsbt
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75