docs: add repository info (#1177)

akka · Jul 28, 2023 · da20330 · da20330
1 parent cd54916
commit da20330
Show file tree

Hide file tree

Showing 14 changed files with 129 additions and 8 deletions.
diff --git a/docs/src/main/paradox/akka-management.md b/docs/src/main/paradox/akka-management.md
@@ -14,6 +14,16 @@ and you have to combine it with the management extension libraries that you want
 or cluster bootstrap). This design choice enables users to include only the minimal set of features they
 actually want to use (and load) in their project.
 
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+}
+
+Additionally, add the dependency as below.
+
 @@dependency[sbt,Gradle,Maven] {
   symbol1=AkkaManagementVersion
   value1="$project.version$"

diff --git a/docs/src/main/paradox/bootstrap/index.md b/docs/src/main/paradox/bootstrap/index.md
@@ -33,7 +33,17 @@ A discovery mechanism needs to be chosen. A good default choice is DNS.
 Add `akka-management-cluster-bootstrap` and one or more discovery mechanisms to use for the discovery process.
 
 For example, you might choose to use the @extref:[DNS discovery](akka:discovery/index.html#discovery-method-dns)
-and bootstrap extensions:
+and bootstrap extensions.
+
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+}
+
+Additionally, add the dependencies as below.
 
 @@dependency[sbt,Gradle,Maven] {
   symbol=AkkaVersion

diff --git a/docs/src/main/paradox/bootstrap/recipes.md b/docs/src/main/paradox/bootstrap/recipes.md
@@ -58,8 +58,17 @@ Note that the `app` is the same for both services as they both refer to the same
 ### Health checks
 
 `akka-management` includes a HTTP route for readiness and liveness checks.
-`akka-management-cluster-http` includes readiness check for the Akka Cluster membership. To use it
-add the following dependency:
+`akka-management-cluster-http` includes readiness check for the Akka Cluster membership.
+
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+}
+
+Additionally, add the dependency as below.
 
 @@dependency[sbt,Gradle,Maven] {
   symbol1=AkkaManagementVersion

diff --git a/docs/src/main/paradox/cluster-http-management.md b/docs/src/main/paradox/cluster-http-management.md
@@ -14,7 +14,17 @@ The operations exposed are comparable to the Command Line Management tool or the
 ## Dependencies
 
 The Akka Cluster HTTP Management is a separate jar file.
-Make sure to include it along with the core akka-management library in your project:
+Make sure to include it along with the core akka-management library in your project.
+
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+}
+
+Additionally, add the dependencies as below.
 
 @@dependency[sbt,Gradle,Maven] {
   symbol1=AkkaManagementVersion

diff --git a/docs/src/main/paradox/discovery/aws.md b/docs/src/main/paradox/discovery/aws.md
@@ -47,7 +47,15 @@ ensure the "Tag New Instances" option is checked.
 
 #### Dependencies and usage (EC2 Tag-Based Discovery)
 
-This is a separate JAR file:
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+}
+
+Additionally, add the dependency as below.
 
 @@dependency[sbt,Gradle,Maven] {
   symbol1=AkkaManagementVersion

diff --git a/docs/src/main/paradox/discovery/consul.md b/docs/src/main/paradox/discovery/consul.md
@@ -16,6 +16,16 @@ If you are using Consul to do the service discovery this would allow you to base
 
 @@project-info{ projectId="akka-discovery-consul" }
 
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+}
+
+Additionally, add the dependency as below.
+
 @@dependency[sbt,Gradle,Maven] {
   symbol1=AkkaManagementVersion
   value1=$project.version$

diff --git a/docs/src/main/paradox/discovery/kubernetes.md b/docs/src/main/paradox/discovery/kubernetes.md
@@ -10,7 +10,15 @@ The typical way to consume a service in Kubernetes is to discover it through DNS
 
 ### Dependencies and usage
 
-First, add the dependency on the component:
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+}
+
+Additionally, add the dependency as below.
 
 @@dependency[sbt,Gradle,Maven] {
   symbol1=AkkaManagementVersion

diff --git a/docs/src/main/paradox/discovery/marathon.md b/docs/src/main/paradox/discovery/marathon.md
@@ -23,7 +23,15 @@ is bound to this port.
 
 ### Dependencies and usage
 
-This is a separate JAR file:
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+}
+
+Additionally, add the dependency as below.
 
 @@dependency[sbt,Gradle,Maven] {
   symbol1=AkkaManagementVersion

diff --git a/docs/src/main/paradox/kubernetes-deployment/forming-a-cluster.md b/docs/src/main/paradox/kubernetes-deployment/forming-a-cluster.md
@@ -24,6 +24,16 @@ Add the following dependencies to your application:
 * @ref[Akka Discovery Kubernetes](../discovery/kubernetes.md): This provides a discovery mechanism that queries the Kubernetes API
 * @ref[Akka Bootstrap](../bootstrap/index.md): This bootstraps the cluster from nodes discovered via the Kubernetes API
 
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+
+
+Additionally, add the dependencies as below.
+
 @@dependency[sbt,Gradle,Maven] {
   symbol1=AkkaManagementVersion
   value1=$project.version$

diff --git a/docs/src/main/paradox/kubernetes-lease.md b/docs/src/main/paradox/kubernetes-lease.md
@@ -34,6 +34,16 @@ applications, you must ensure different `ActorSystem` names because they all nee
 
 #### Dependency
 
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+}
+
+Additionally, add the dependency as below.
+
 @@dependency[sbt,Maven,Gradle] {
   symbol1=AkkaManagementVersion
   value1=$project.version$

diff --git a/docs/src/main/paradox/loglevels/log4j2.md b/docs/src/main/paradox/loglevels/log4j2.md
@@ -8,6 +8,16 @@ Dynamic Log Levels for Log4j2 hooks into Akka Management and provides a route wh
 
 Requires @ref:[Akka Management](../akka-management.md) and that the application uses [Log4j2](https://logging.apache.org/log4j/2.x/) as logging backend.
 
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+}
+
+Additionally, add the dependencies as below.
+
 @@dependency[sbt,Gradle,Maven] {
   symbol1=AkkaManagementVersion
   value1=$project.version$

diff --git a/docs/src/main/paradox/loglevels/logback.md b/docs/src/main/paradox/loglevels/logback.md
@@ -8,6 +8,16 @@ Dynamic Log Levels for Logback hooks into Akka Management and provides a route w
 
 Requires @ref:[Akka Management](../akka-management.md) and that the application uses [Logback](http://logback.qos.ch) as logging backend.
 
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+}
+
+Additionally, add the dependencies as below.
+
 @@dependency[sbt,Gradle,Maven] {
   symbol1=AkkaManagementVersion
   value1=$project.version$

diff --git a/docs/src/main/paradox/rolling-updates.md b/docs/src/main/paradox/rolling-updates.md
@@ -45,6 +45,14 @@ This module provides the Pod Deletion Cost extension which automatically annotat
 
 ### Dependency
 
+The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.
+
+@@repository [sbt,Gradle,Maven] {
+id="akka-repository"
+name="Akka library repository"
+url="https://repo.akka.io/maven"
+}
+
 Add `akka-rolling-update-kubernetes` to your dependency management tool:
 
 @@dependency[sbt,Gradle,Maven] {

diff --git a/project/plugins.sbt b/project/plugins.sbt
@@ -3,7 +3,7 @@ addSbtPlugin("com.github.sbt" % "sbt-native-packager" % "1.9.16")
 addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.10.0")
 addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.3")
 addSbtPlugin("com.github.sbt" % "sbt-dynver" % "5.0.1")
-addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.49")
+addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.51")
 addSbtPlugin("com.github.sbt" % "sbt-unidoc" % "0.5.0")
 addSbtPlugin("com.github.sbt" % "sbt-site-paradox" % "1.5.0")
 addSbtPlugin("com.lightbend.sbt" % "sbt-publish-rsync" % "0.2")