diff --git a/akka-docs/src/main/paradox/cluster-client.md b/akka-docs/src/main/paradox/cluster-client.md index e6e772c958..0198d23182 100644 --- a/akka-docs/src/main/paradox/cluster-client.md +++ b/akka-docs/src/main/paradox/cluster-client.md @@ -165,23 +165,11 @@ Java To use the Cluster Client you must add the following dependency in your project. -sbt -: @@@vars - ``` - "com.typesafe.akka" %% "akka-cluster-tools" % "$akka.version$" - ``` - @@@ - -Maven -: @@@vars - ``` - - com.typesafe.akka - akka-cluster-tools_$scala.binary_version$ - $akka.version$ - - ``` - @@@ +@@dependency[sbt,Maven,Gradle] { + group="com.typesafe.akka" + artifact="akka-cluster-tools_$scala.binary_version$" + version="$akka.version$" +} ## Configuration diff --git a/akka-docs/src/main/paradox/cluster-metrics.md b/akka-docs/src/main/paradox/cluster-metrics.md index 1671437f2e..492dc37bb5 100644 --- a/akka-docs/src/main/paradox/cluster-metrics.md +++ b/akka-docs/src/main/paradox/cluster-metrics.md @@ -102,25 +102,12 @@ unique per instance directory. You can control the extract directory with the @@@ To enable usage of Sigar you can add the following dependency to the user project -: -Scala -: @@@vars -``` -"io.kamon" % "sigar-loader" % "$sigar_loader.version$" -``` -@@@ - -Java -: @@@vars -``` - - io.kamon - sigar-loader - $sigar_loader.version$ - -``` -@@@ +@@dependency[sbt,Maven,Gradle] { + group="io.kamon" + artifact="sigar-loader" + version="$sigar_loader.version$" +} You can download Kamon sigar-loader from [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Csigar-loader) diff --git a/akka-docs/src/main/paradox/cluster-sharding.md b/akka-docs/src/main/paradox/cluster-sharding.md index f6a76fcea6..268ee69bae 100644 --- a/akka-docs/src/main/paradox/cluster-sharding.md +++ b/akka-docs/src/main/paradox/cluster-sharding.md @@ -427,30 +427,11 @@ different persistenceId. To use the Cluster Sharding you must add the following dependency in your project. -sbt -: @@@vars - ``` - "com.typesafe.akka" %% "akka-cluster-sharding" % "$akka.version$" - ``` - @@@ - -Gradle -: @@@vars - ``` - compile group: 'com.typesafe.akka', name: 'akka-cluster-sharding_$scala.binary_version$', version: '$akka.version$' - ``` - @@@ - -Maven -: @@@vars - ``` - - com.typesafe.akka - akka-cluster-sharding_$scala.binary_version$ - $akka.version$ - - ``` - @@@ +@@dependency[sbt,Maven,Gradle] { + group="com.typesafe.akka" + artifact="akka-cluster-sharding_$scala.binary_version$" + version="$akka.version$" +} ## Configuration diff --git a/akka-docs/src/main/paradox/cluster-singleton.md b/akka-docs/src/main/paradox/cluster-singleton.md index 8bccf019e5..05c8b7a7ef 100644 --- a/akka-docs/src/main/paradox/cluster-singleton.md +++ b/akka-docs/src/main/paradox/cluster-singleton.md @@ -132,23 +132,11 @@ A more comprehensive sample is available in the tutorial named To use the Cluster Singleton you must add the following dependency in your project. -sbt -: @@@vars - ``` - "com.typesafe.akka" %% "akka-cluster-tools" % "$akka.version$" - ``` - @@@ - -Maven -: @@@vars - ``` - - com.typesafe.akka - akka-cluster-tools_$scala.binary_version$ - $akka.version$ - - ``` - @@@ +@@dependency[sbt,Maven,Gradle] { + group="com.typesafe.akka" + artifact="akka-cluster-tools_$scala.binary_version$" + version="$akka.version$" +} ## Configuration diff --git a/akka-docs/src/main/paradox/distributed-data.md b/akka-docs/src/main/paradox/distributed-data.md index 0bb795a371..2f8fa5b923 100644 --- a/akka-docs/src/main/paradox/distributed-data.md +++ b/akka-docs/src/main/paradox/distributed-data.md @@ -88,7 +88,7 @@ at least **N/2 + 1** replicas, where N is the number of nodes in the cluster (or all nodes in the cluster role group) When you specify to write to `n` out of `x` nodes, the update will first replicate to `n` nodes. -If there are not enough Acks after 1/5th of the timeout, the update will be replicated to `n` other +If there are not enough Acks after a 1/5th of the timeout, the update will be replicated to `n` other nodes. If there are less than n nodes left all of the remaining nodes are used. Reachable nodes are preferred over unreachable nodes. @@ -265,7 +265,7 @@ Java In some rare cases, when performing an `Update` it is needed to first try to fetch latest data from other nodes. That can be done by first sending a `Get` with `ReadMajority` and then continue with the `Update` when the `GetSuccess`, `GetFailure` or `NotFound` reply is received. This might be -needed when you need to base a decision on latest information or when removing entries from `ORSet` +needed when you need to base a decision on latest information or when removing entries from an `ORSet` or `ORMap`. If an entry is added to an `ORSet` or `ORMap` from one node and removed from another node the entry will only be removed if the added entry is visible on the node where the removal is performed (hence the name observed-removed set). @@ -346,7 +346,7 @@ types that support both updates and removals, for example `ORMap` or `ORSet`. ### delta-CRDT [Delta State Replicated Data Types](http://arxiv.org/abs/1603.01529) -are supported. delta-CRDT is a way to reduce the need for sending the full state +are supported. A delta-CRDT is a way to reduce the need for sending the full state for updates. For example adding element `'c'` and `'d'` to set `{'a', 'b'}` would result in sending the delta `{'c', 'd'}` and merge that with the state on the receiving side, resulting in set `{'a', 'b', 'c', 'd'}`. @@ -355,7 +355,7 @@ The protocol for replicating the deltas supports causal consistency if the data is marked with `RequiresCausalDeliveryOfDeltas`. Otherwise it is only eventually consistent. Without causal consistency it means that if elements `'c'` and `'d'` are added in two separate *Update* operations these deltas may occasionally be propagated -to nodes in different order than the causal order of the updates. For this example it +to nodes in a different order to the causal order of the updates. For this example it can result in that set `{'a', 'b', 'd'}` can be seen before element 'c' is seen. Eventually it will be `{'a', 'b', 'c', 'd'}`. @@ -393,7 +393,7 @@ each node. If you need both increments and decrements you can use the `PNCounter` (positive/negative counter). It is tracking the increments (P) separate from the decrements (N). Both P and N are represented -as two internal `GCounter`. Merge is handled by merging the internal P and N counters. +as two internal `GCounter`s. Merge is handled by merging the internal P and N counters. The value of the counter is the value of the P counter minus the value of the N counter. Scala @@ -785,30 +785,11 @@ paper by Mark Shapiro et. al. To use Distributed Data you must add the following dependency in your project. -sbt -: @@@vars - ``` - "com.typesafe.akka" %% "akka-distributed-data" % "$akka.version$" - ``` - @@@ - -Gradle -: @@@vars - ``` - compile group: 'com.typesafe.akka', name: 'akka-distributed-data_$scala.binary_version$', version: '$akka.version$' - ``` - @@@ - -Maven -: @@@vars - ``` - - com.typesafe.akka - akka-distributed-data_$scala.binary_version$ - $akka.version$ - - ``` - @@@ +@@dependency[sbt,Maven,Gradle] { + group="com.typesafe.akka" + artifact="akka-distributed-data_$scala.binary_version$" + version="$akka.version$" +} ## Configuration diff --git a/akka-docs/src/main/paradox/distributed-pub-sub.md b/akka-docs/src/main/paradox/distributed-pub-sub.md index 94f3a11711..0256a5bcf4 100644 --- a/akka-docs/src/main/paradox/distributed-pub-sub.md +++ b/akka-docs/src/main/paradox/distributed-pub-sub.md @@ -222,27 +222,8 @@ If you are looking for at-least-once delivery guarantee, we recommend [Kafka Akk To use Distributed Publish Subscribe you must add the following dependency in your project. -sbt -: @@@vars - ``` - "com.typesafe.akka" %% "akka-cluster-tools" % "$akka.version$" - ``` - @@@ - -Gradle -: @@@vars - ``` - compile group: 'com.typesafe.akka', name: 'akka-cluster-tools_$scala.binary_version$', version: '$akka.version$' - ``` - @@@ - -Maven -: @@@vars - ``` - - com.typesafe.akka - akka-cluster-tools_$scala.binary_version$ - $akka.version$ - - ``` - @@@ +@@dependency[sbt,Maven,Gradle] { + group="com.typesafe.akka" + artifact="akka-cluster-tools_$scala.binary_version$" + version="$akka.version$" +} diff --git a/akka-docs/src/main/paradox/logging.md b/akka-docs/src/main/paradox/logging.md index 5ce76e2607..6d4204b46c 100644 --- a/akka-docs/src/main/paradox/logging.md +++ b/akka-docs/src/main/paradox/logging.md @@ -339,20 +339,11 @@ stdout logger is `WARNING` and it can be silenced completely by setting Akka provides a logger for [SLF4J](http://www.slf4j.org/). This module is available in the 'akka-slf4j.jar'. It has a single dependency: the slf4j-api jar. In your runtime, you also need a SLF4J backend. We recommend [Logback](http://logback.qos.ch/): -sbt -: ```scala -libraryDependencies += "ch.qos.logback" % "logback-classic" % "1.2.3" -``` - -Maven -: ```xml - - ch.qos.logback - logback-classic - 1.2.3 - - ``` - +@@dependency[sbt,Maven,Gradle] { + group="ch.qos.logback" + artifact="logback-classic" + version="1.2.3" +} You need to enable the Slf4jLogger in the `loggers` element in the @ref:[configuration](general/configuration.md). Here you can also define the log level of the event bus. diff --git a/akka-docs/src/main/paradox/persistence-query-leveldb.md b/akka-docs/src/main/paradox/persistence-query-leveldb.md index e2bba4bd92..eec12b3114 100644 --- a/akka-docs/src/main/paradox/persistence-query-leveldb.md +++ b/akka-docs/src/main/paradox/persistence-query-leveldb.md @@ -8,30 +8,11 @@ Note that implementations for other journals may have different semantics. Akka persistence LevelDB query implementation is bundled in the `akka-persistence-query` artifact. Make sure that you have the following dependency in your project: -sbt -: @@@vars - ``` - "com.typesafe.akka" %% "akka-persistence-query" % "$akka.version$" - ``` - @@@ - -Gradle -: @@@vars - ``` - compile group: 'com.typesafe.akka', name: 'akka-persistence-query_$scala.binary_version$', version: '$akka.version$' - ``` - @@@ - -Maven -: @@@vars - ``` - - com.typesafe.akka - akka-persistence-query_$scala.binary_version$ - $akka.version$ - - ``` - @@@ +@@dependency[sbt,Maven,Gradle] { + group="com.typesafe.akka" + artifact="akka-persistence-query_$scala.binary_version$" + version="$akka.version$" +} ## How to get the ReadJournal diff --git a/akka-docs/src/main/paradox/persistence-query.md b/akka-docs/src/main/paradox/persistence-query.md index cce3fe6062..c632916c10 100644 --- a/akka-docs/src/main/paradox/persistence-query.md +++ b/akka-docs/src/main/paradox/persistence-query.md @@ -14,30 +14,11 @@ recommend (in the spirit of CQRS) of splitting up the write/read sides into sepa Akka persistence query is a separate jar file. Make sure that you have the following dependency in your project: -sbt -: @@@vars - ``` - "com.typesafe.akka" %% "akka-persistence-query" % "$akka.version$" - ``` - @@@ - -Gradle -: @@@vars - ``` - compile group: 'com.typesafe.akka', name: 'akka-persistence-query_$scala.binary_version$', version: '$akka.version$' - ``` - @@@ - -Maven -: @@@vars - ``` - - com.typesafe.akka - akka-persistence-query_$scala.binary_version$ - $akka.version$ - - ``` - @@@ +@@dependency[sbt,Maven,Gradle] { + group="com.typesafe.akka" + artifact="akka-persistence-query_$scala.binary_version$" + version="$akka.version$" +} ## Design overview diff --git a/akka-docs/src/main/paradox/persistence.md b/akka-docs/src/main/paradox/persistence.md index 5b545ed8ec..505e33cb70 100644 --- a/akka-docs/src/main/paradox/persistence.md +++ b/akka-docs/src/main/paradox/persistence.md @@ -1128,31 +1128,11 @@ In order to help developers build correct and high quality storage plugins, we p The TCK is usable from Java as well as Scala projects. To test your implementation (independently of language) you need to include the akka-persistence-tck dependency: -sbt -: @@@vars - ``` - "com.typesafe.akka" %% "akka-persistence-tck" % "$akka.version$" % "test" - ``` - @@@ - -Gradle -: @@@vars - ``` - testCompile group: 'com.typesafe.akka', name: 'akka-persistence-tck_$scala.binary_version$', version: '$akka.version$' - ``` - @@@ - -Maven -: @@@vars - ``` - - com.typesafe.akka - akka-persistence-tck_$scala.binary_version$ - $akka.version$ - test - - ``` - @@@ +@@dependency[sbt,Maven,Gradle] { + group="com.typesafe.akka" + artifact="akka-persistence-tck_$scala.binary_version$" + version="$akka.version$" +} To include the Journal TCK tests in your test suite simply extend the provided @scala[`JournalSpec`]@java[`JavaJournalSpec`]: @@ -1204,30 +1184,11 @@ instance. Enable this plugin by defining config property: LevelDB based plugins will also require the following additional dependency declaration: -sbt -: @@@vars - ``` - "org.fusesource.leveldbjni" % "leveldbjni-all" % "1.8" - ``` - @@@ - -Gradle -: @@@vars - ``` - compile group: 'org.fusesource.leveldbjni', name: 'leveldbjni-all', version: '1.8' - ``` - @@@ - -Maven -: @@@vars - ``` - - org.fusesource.leveldbjni - leveldbjni-all - 1.8 - - ``` - @@@ +@@dependency[sbt,Maven,Gradle] { + group="org.fusesource.leveldbjni" + artifact="leveldbjni-all" + version="1.8" +} The default location of LevelDB files is a directory named `journal` in the current working directory. This location can be changed by configuration where the specified path can be relative or absolute: @@ -1378,31 +1339,11 @@ in your Akka configuration. The LevelDB Java port is for testing purposes only. Also note that for the LevelDB Java port, you will need the following dependencies: -sbt -: @@@vars - ``` - "org.iq80.leveldb" % "leveldb" % "0.9" % "test" - ``` - @@@ - -Gradle -: @@@vars - ``` - testCompile group: 'org.iq80.leveldb', name: 'leveldb', version: '0.9' - ``` - @@@ - -Maven -: @@@vars - ``` - - org.iq80.leveldb - leveldb - 0.9 - test - - ``` - @@@ +@@dependency[sbt,Maven,Gradle] { + group="org.iq80.leveldb" + artifact="leveldb" + version="0.9" +} @@@ warning diff --git a/akka-docs/src/main/paradox/remoting-artery.md b/akka-docs/src/main/paradox/remoting-artery.md index 7634f6ad4d..50d9b61272 100644 --- a/akka-docs/src/main/paradox/remoting-artery.md +++ b/akka-docs/src/main/paradox/remoting-artery.md @@ -52,24 +52,11 @@ are also different. The Akka remoting is a separate jar file. Make sure that you have the following dependency in your project: -Scala -: @@@vars - ``` - "com.typesafe.akka" %% "akka-remote" % "$akka.version$" - ``` - @@@ - -Java -: @@@vars - ``` - - com.typesafe.akka - akka-remote_$scala.binary_version$ - $akka.version$ - - ``` - @@@ - +@@dependency[sbt,Maven,Gradle] { + group="com.typesafe.akka" + artifact="akka-remote_$scala.binary_version$" + version="$akka.version$" +} To enable remote capabilities in your Akka project you should, at a minimum, add the following changes to your `application.conf` file: diff --git a/akka-docs/src/main/paradox/remoting.md b/akka-docs/src/main/paradox/remoting.md index 2e92f68ba8..a3d8002ccd 100644 --- a/akka-docs/src/main/paradox/remoting.md +++ b/akka-docs/src/main/paradox/remoting.md @@ -20,21 +20,11 @@ network and/or Akka configuration will have to be changed as described in The Akka remoting is a separate jar file. Make sure that you have the following dependency in your project: -@@@vars -sbt -: ``` -"com.typesafe.akka" %% "akka-remote" % "$akka.version$" -``` - -Maven -: ``` - - com.typesafe.akka - akka-remote_$scala.binary_version$ - $akka.version$ - -``` -@@@ +@@dependency[sbt,Maven,Gradle] { + group="com.typesafe.akka" + artifact="akka-remote_$scala.binary_version$" + version="$akka.version$" +} To enable remote capabilities in your Akka project you should, at a minimum, add the following changes to your `application.conf` file: