Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add repository info #945

Merged
merged 2 commits into from
Jul 28, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/src/main/paradox/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ processing semantics, but not exactly-once.

## Dependencies

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [Maven,sbt,Gradle] {
aludwiko marked this conversation as resolved.
Show resolved Hide resolved
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

To use the Cassandra module of Akka Projections add the following dependency in your project:

@@dependency [sbt,Maven,Gradle] {
Expand Down
8 changes: 8 additions & 0 deletions docs/src/main/paradox/durable-state.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ When using the R2DBC plugin an alternative to using a Projection is to @extref:[

## Dependencies

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [Maven,sbt,Gradle] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

To use the Durable State module of Akka Projections, add the following dependency in your project:

@@dependency [sbt,Maven,Gradle] {
Expand Down
8 changes: 8 additions & 0 deletions docs/src/main/paradox/eventsourced.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ Akka Projections has integration with `eventsByTag`, which is described here.

## Dependencies

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [Maven,sbt,Gradle] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

To use the Event Sourced module of Akka Projections add the following dependency in your project:

@@dependency [sbt,Maven,Gradle] {
Expand Down
10 changes: 10 additions & 0 deletions docs/src/main/paradox/getting-started/setup-your-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@
Add the Akka Projections core library to a new project.
This isn't strictly required, because as we add other dependencies in the following steps it will transitively include core as a dependency, but it never hurts to be explicit.

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [Maven,sbt,Gradle] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

Additionally, add the dependency as below.

@@dependency [sbt,Maven,Gradle] {
group=com.lightbend.akka
artifact=akka-projection-core_$scala.binary.version$
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ The functionality is provided through the `akka-projection-grpc` module.

@@project-info{ projectId="akka-projection-grpc" }

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [Maven,sbt,Gradle] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

To use the gRPC module of Akka Projections add the following dependency in your project:

@@dependency [sbt,Maven,Gradle] {
Expand Down
8 changes: 8 additions & 0 deletions docs/src/main/paradox/grpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ messages or stored data.

## Dependencies

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [Maven,sbt,Gradle] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

To use the gRPC module of Akka Projections add the following dependency in your project:

@@dependency [sbt,Maven,Gradle] {
Expand Down
8 changes: 8 additions & 0 deletions docs/src/main/paradox/jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ processing semantics is supported. It also offers @ref:[at-least-once](#at-least

## Dependencies

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [Maven,sbt,Gradle] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

To use the JDBC module of Akka Projections add the following dependency in your project:

@@dependency [sbt,Maven,Gradle] {
Expand Down
8 changes: 8 additions & 0 deletions docs/src/main/paradox/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ A `Projection` can also @ref:[send messages to Kafka](#sending-to-kafka).

## Dependencies

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [Maven,sbt,Gradle] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

To use the Kafka module of Akka Projections add the following dependency in your project:

@@dependency [sbt,Maven,Gradle] {
Expand Down
8 changes: 8 additions & 0 deletions docs/src/main/paradox/r2dbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ that @ref:[exactly-once](#exactly-once) processing semantics is supported. It al

## Dependencies

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [Maven,sbt,Gradle] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

To use the R2DBC module of Akka Projections add the following dependency in your project:

@@dependency [Maven,sbt,Gradle] {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was already wrong here, should we fix it in this pr or a separate one?

Expand Down
8 changes: 8 additions & 0 deletions docs/src/main/paradox/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ Once you have decided how you want to build your projection, the next step is to

## Dependencies

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [Maven,sbt,Gradle] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

To distribute the projection over the cluster we recommend the use of [ShardedDaemonProcess](https://doc.akka.io/docs/akka/current/typed/cluster-sharded-daemon-process.html). Add the following dependency in your project if not yet using Akka Cluster Sharding:

@@dependency [sbt,Maven,Gradle] {
Expand Down
8 changes: 8 additions & 0 deletions docs/src/main/paradox/slick.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ processing semantics is supported. It also offers @ref:[at-least-once](#at-least

## Dependencies

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [Maven,sbt,Gradle] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

To use the Slick module of Akka Projections add the following dependency in your project:

@@dependency [sbt,Maven,Gradle] {
Expand Down
8 changes: 8 additions & 0 deletions docs/src/main/paradox/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ Akka Projections provides a TestKit to ease testing. There are two supported sty

## Dependencies

The Akka dependencies are available from Akka's library repository. To access them there, you need to configure the URL for this repository.

@@repository [Maven,sbt,Gradle] {
id="akka-repository"
name="Akka library repository"
url="https://repo.akka.io/maven"
}

To use the Akka Projections TestKit add the following dependency in your project:

@@dependency [sbt,Maven,Gradle] {
Expand Down
2 changes: 1 addition & 1 deletion project/plugins.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.5.12")
addSbtPlugin("com.lightbend.akka.grpc" % "sbt-akka-grpc" % "2.3.2")

// Documentation
addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.49")
addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.51")
Copy link
Contributor

@franciscolopezsancho franciscolopezsancho Jul 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this? In this PR I mean.

addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-dependencies" % "0.2.2")
addSbtPlugin("com.lightbend.sbt" % "sbt-publish-rsync" % "0.2")
addSbtPlugin("com.eed3si9n" % "sbt-unidoc" % "0.4.3")
Expand Down