Mark cluster as experimental, see #2455

* Speparate section in docs, explaining what experimental means
* Renamed the artifactId to akka-cluster-experimental and
 akka-remote-tests-experimental
This commit is contained in:
Patrik Nordwall 2012-09-11 09:16:17 +02:00
parent 2cd817c3c0
commit a6a2eba231
5 changed files with 31 additions and 7 deletions

View file

@ -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 <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`.

View file

@ -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 <experimental>`. This document describes the design concepts of the new clustering coming in Akka Coltrane. Not everything described here is implemented yet.
Intro
=====

View file

@ -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

View file

@ -9,8 +9,8 @@ Contents
common/index
java/index
scala/index
cluster/index
modules/index
experimental/index
dev/index
project/index
additional/index

View file

@ -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(