raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

doc Replace the word stage by operator in stream doc (#25138)

Browse source
This commit is contained in:
Richard Imaoka 2018-05-29 17:00:48 +09:00 • committed by Arnout Engelen
parent 1919f222fa
commit a17a61557c
142 changed files with 341 additions and 341 deletions
Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -383,9 +383,9 @@ tested it becomes an officially supported Akka feature.
[List of Akka features marked as may change](http://doc.akka.io/docs/akka/current/common/may-change.html)
## Contributing new Akka Streams stages/operators
## Contributing new Akka Streams operators
Documentation of Akka Streams operators and stages is automatically enforced.
Documentation of Akka Streams operators is automatically enforced.
If a method exists on Source / Sink / Flow, or any other class listed in `project/StreamOperatorsIndexGenerator.scala`,
it must also have a corresponding documentation page under `akka-docs/src/main/paradox/streams/operators/...`.
@ -393,11 +393,11 @@ The pages structure is well-defined, and must be the same on all documentation p
docs pages in there to see the pattern in action. In general though the page must consist of:
- the title, including where the operator is defined (e.g. `ActorFlow.ask` or `Source.map`)
- a short explanation of what this stage does, 1 sentence is optimal
- an image explaining the stage more visually (whenever possible)
- a link to the stages' "category" (these are listed in `akka-docs/src/main/paradox/categories`)
- a short explanation of what this operator does, 1 sentence is optimal
- an image explaining the operator more visually (whenever possible)
- a link to the operators' "category" (these are listed in `akka-docs/src/main/paradox/categories`)
- the method signature snippet (use the built in directives to generate it)
- a longer explanation about the stage and it's exact semantics (when it pulls, cancels, signals elements)
- a longer explanation about the operator and it's exact semantics (when it pulls, cancels, signals elements)
- at least one usage example
Using this structure, the surrounding infrastructure will **generate the index pages**, so you do not need to maintain