From 49b59083e268d8a697e397d1e6f2e61f3159f86c Mon Sep 17 00:00:00 2001 From: Konrad `ktoso` Malawski Date: Tue, 23 Jan 2018 23:34:11 +0900 Subject: [PATCH] Add ApiMayChange warning in docs of StreamRefs (#24389) * Add ApiMayChange warning in docs of StreamRefs * Update stream-refs.md --- akka-docs/src/main/paradox/stream/stream-refs.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/akka-docs/src/main/paradox/stream/stream-refs.md b/akka-docs/src/main/paradox/stream/stream-refs.md index 1d1b09a614..20fcca0b96 100644 --- a/akka-docs/src/main/paradox/stream/stream-refs.md +++ b/akka-docs/src/main/paradox/stream/stream-refs.md @@ -1,4 +1,13 @@ -# Akka Streams over network boundaries +# StreamRefs - streams over network boundaries + +@@@ warning + +This module is currently marked as @ref:[may change](../common/may-change.md) in the sense + of being the subject of active research. This means that API or semantics can + change without warning or deprecation period and it is not recommended to use + this module in production just yet—you have been warned. + +@@@ Stream references, or "stream refs" for short, allow running Akka Streams across multiple nodes within an Akka Cluster.