diff --git a/akka-docs/cluster/cluster-usage.rst b/akka-docs/cluster/cluster-usage.rst index 0b72dbce70..cda527c79e 100644 --- a/akka-docs/cluster/cluster-usage.rst +++ b/akka-docs/cluster/cluster-usage.rst @@ -5,9 +5,7 @@ Cluster Usage ############### -.. note:: This document describes how to use the features implemented so far of the - new clustering coming in Akka Coltrane and is not available in the latest stable release. - The API might change before it is released. +.. note:: This module is :ref:`experimental `. This document describes how to use the features implemented so far. More features are coming in Akka Coltrane. For introduction to the Akka Cluster concepts please see :ref:`cluster`. diff --git a/akka-docs/cluster/cluster.rst b/akka-docs/cluster/cluster.rst index 040a2fef9f..1190da953a 100644 --- a/akka-docs/cluster/cluster.rst +++ b/akka-docs/cluster/cluster.rst @@ -5,7 +5,7 @@ Cluster Specification ###################### -.. note:: *This document describes the new clustering coming in Akka Coltrane and is not available in the latest stable release)* +.. note:: This module is :ref:`experimental `. This document describes the design concepts of the new clustering coming in Akka Coltrane. Not everything described here is implemented yet. Intro ===== diff --git a/akka-docs/experimental/index.rst b/akka-docs/experimental/index.rst new file mode 100644 index 0000000000..c3b90bc290 --- /dev/null +++ b/akka-docs/experimental/index.rst @@ -0,0 +1,26 @@ +.. _experimental: + +#################### +Experimental Modules +#################### + +The following modules of Akka are marked as experimental, which means +that they are in early access mode. The purpose of releasing them +early, as experimental, is to make them easily available and improve +based on feedback, or even discover that the module wasn't useful. + +An experimental module doesn't have to obey the rule of staying binary +compatible between minor releases. Breaking API changes may be introduced +in minor releases without notice as we refine and simplify based on your +feedback. An experimental module may be dropped in major releases without +prior deprecation. + +Another reason for marking a module as experimental is that it's too early +to tell if the module has a maintainer that can take the responsibility +of the module over time. + +.. toctree:: + :maxdepth: 2 + + ../cluster/index + diff --git a/akka-docs/index.rst b/akka-docs/index.rst index f1a30627c1..05b57dc816 100644 --- a/akka-docs/index.rst +++ b/akka-docs/index.rst @@ -9,8 +9,8 @@ Contents common/index java/index scala/index - cluster/index modules/index + experimental/index dev/index project/index additional/index diff --git a/project/AkkaBuild.scala b/project/AkkaBuild.scala index db819d68d8..8c102ec39f 100644 --- a/project/AkkaBuild.scala +++ b/project/AkkaBuild.scala @@ -129,7 +129,7 @@ object AkkaBuild extends Build { ) lazy val remoteTests = Project( - id = "akka-remote-tests", + id = "akka-remote-tests-experimental", base = file("akka-remote-tests"), dependencies = Seq(remote, actorTests % "test->test", testkit % "test->test"), settings = defaultSettings ++ multiJvmSettings ++ Seq( @@ -145,7 +145,7 @@ object AkkaBuild extends Build { ) configs (MultiJvm) lazy val cluster = Project( - id = "akka-cluster", + id = "akka-cluster-experimental", base = file("akka-cluster"), dependencies = Seq(remote, remoteTests % "compile;test->test;multi-jvm->multi-jvm", testkit % "test->test"), settings = defaultSettings ++ multiJvmSettings ++ OSGi.cluster ++ Seq(