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: revise URL structure (libraries) #601

Merged
merged 2 commits into from
Sep 23, 2024
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

The Akka family of projects is managed by teams at [Lightbend](https://lightbend.com/) with help from the community.

[Akka Persistence](https://doc.akka.io/docs/akka/current/scala/persistence.html) journal and snapshot
[Akka Persistence](https://doc.akka.io/libraries/akka-core/current/scala/persistence.html) journal and snapshot
store for SQL datbases with RD2BC connectivity.

For questions please use the [discuss.akka.io](https://discuss.akka.io). Tag any new questions with `akka-persistence` and `r2dbc`.

The documentation can be found [here](https://doc.akka.io/docs/akka-persistence-r2dbc/current/index.html)
The documentation can be found [here](https://doc.akka.io/libraries/akka-persistence-r2dbc/current/index.html)

## Project status

Expand Down
14 changes: 7 additions & 7 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ inThisBuild(
Seq(
organization := "com.lightbend.akka",
organizationName := "Lightbend Inc.",
homepage := Some(url("https://doc.akka.io/docs/akka-persistence-r2dbc/current")),
homepage := Some(url("https://doc.akka.io/libraries/akka-persistence-r2dbc/current")),
scmInfo := Some(
ScmInfo(
url("https://github.com/akka/akka-persistence-r2dbc"),
Expand Down Expand Up @@ -137,21 +137,21 @@ lazy val docs = project
previewPath := (Paradox / siteSubdirName).value,
Preprocess / siteSubdirName := s"api/akka-persistence-r2dbc/${projectInfoVersion.value}",
Preprocess / sourceDirectory := (LocalRootProject / ScalaUnidoc / unidoc / target).value,
Paradox / siteSubdirName := s"docs/akka-persistence-r2dbc/${projectInfoVersion.value}",
Paradox / siteSubdirName := s"libraries/akka-persistence-r2dbc/${projectInfoVersion.value}",
paradoxGroups := Map(
"Language" -> Seq("Java", "Scala"),
"Dialect" -> Seq("Postgres", "Yugabyte", "H2", "SQLServer")),
Compile / paradoxProperties ++= Map(
"project.url" -> "https://doc.akka.io/docs/akka-persistence-r2dbc/current/",
"canonical.base_url" -> "https://doc.akka.io/docs/akka-persistence-r2dbc/current",
"project.url" -> "https://doc.akka.io/libraries/akka-persistence-r2dbc/current/",
"canonical.base_url" -> "https://doc.akka.io/libraries/akka-persistence-r2dbc/current",
"akka.version" -> Dependencies.AkkaVersion,
"h2.version" -> Dependencies.H2Version,
"r2dbc-h2.version" -> Dependencies.R2dbcH2Version,
"scala.version" -> scalaVersion.value,
"scala.binary.version" -> scalaBinaryVersion.value,
"extref.akka.base_url" -> s"https://doc.akka.io/docs/akka/${Dependencies.AkkaVersionInDocs}/%s",
"extref.akka-docs.base_url" -> s"https://doc.akka.io/docs/akka/${Dependencies.AkkaVersionInDocs}/%s",
"extref.akka-projection.base_url" -> s"https://doc.akka.io/docs/akka-projection/${Dependencies.AkkaProjectionVersionInDocs}/%s",
"extref.akka.base_url" -> s"https://doc.akka.io/libraries/akka-core/${Dependencies.AkkaVersionInDocs}/%s",
"extref.akka-docs.base_url" -> s"https://doc.akka.io/libraries/akka-core/${Dependencies.AkkaVersionInDocs}/%s",
"extref.akka-projection.base_url" -> s"https://doc.akka.io/libraries/akka-projection/${Dependencies.AkkaProjectionVersionInDocs}/%s",
"extref.java-docs.base_url" -> "https://docs.oracle.com/en/java/javase/11/%s",
"scaladoc.scala.base_url" -> s"https://www.scala-lang.org/api/current/",
"scaladoc.akka.persistence.r2dbc.base_url" -> s"/${(Preprocess / siteSubdirName).value}/",
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/resources/reference.conf
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ akka.persistence.r2dbc {
# currentEventsBySlicesStartingFromSnapshots are used. That has a small overhead when storing
# snapshots because the timestamp and tags of the corresponding event is retrieved when storing
# a snapshot.
# See also https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
# See also https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
enabled = false
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ object R2dbcSettings {
"Database dialect config has moved from 'akka.persistence.r2dbc.dialect' into the connection-factory block, " +
"the old 'dialect' config entry must be removed, " +
"see akka-persistence-r2dbc documentation for details on the new configuration scheme: " +
"https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html")
"https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html")
}

val schema: Option[String] = Option(config.getString("schema")).filterNot(_.trim.isEmpty)
Expand Down Expand Up @@ -102,7 +102,7 @@ object R2dbcSettings {
"The Akka Persistence R2DBC database config scheme has changed, the config needs to be updated " +
"to choose database dialect using the connection-factory block, " +
"see akka-persistence-r2dbc documentation for details on the new configuration scheme: " +
"https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html")
"https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html")
}
Vector(ConnectionFactorySettings(config.getConfig("connection-factory")))
} else {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ final class R2dbcReadJournal(delegate: scaladsl.R2dbcReadJournal)
*
* To use `currentEventsBySlicesStartingFromSnapshots` you must enable configuration
* `akka.persistence.r2dbc.query.start-from-snapshot.enabled` and follow instructions in migration guide
* https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
* https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
*/
override def currentEventsBySlicesStartingFromSnapshots[Snapshot, Event](
entityType: String,
Expand All @@ -141,7 +141,7 @@ final class R2dbcReadJournal(delegate: scaladsl.R2dbcReadJournal)
*
* To use `eventsBySlicesStartingFromSnapshots` you must enable configuration
* `akka.persistence.r2dbc.query.start-from-snapshot.enabled` and follow instructions in migration guide
* https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
* https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
*/
override def eventsBySlicesStartingFromSnapshots[Snapshot, Event](
entityType: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ final class R2dbcReadJournal(system: ExtendedActorSystem, config: Config, cfgPat
*
* To use `currentEventsBySlicesStartingFromSnapshots` you must enable configuration
* `akka.persistence.r2dbc.query.start-from-snapshot.enabled` and follow instructions in migration guide
* https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
* https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
*/
override def currentEventsBySlicesStartingFromSnapshots[Snapshot, Event](
entityType: String,
Expand Down Expand Up @@ -328,7 +328,7 @@ final class R2dbcReadJournal(system: ExtendedActorSystem, config: Config, cfgPat
*
* To use `eventsBySlicesStartingFromSnapshots` you must enable configuration
* `akka.persistence.r2dbc.query.start-from-snapshot.enabled` and follow instructions in migration guide
* https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
* https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
*/
override def eventsBySlicesStartingFromSnapshots[Snapshot, Event](
entityType: String,
Expand Down Expand Up @@ -417,7 +417,7 @@ final class R2dbcReadJournal(system: ExtendedActorSystem, config: Config, cfgPat
throw new IllegalArgumentException(
s"To use $methodName you must enable " +
"configuration `akka.persistence.r2dbc.query.start-from-snapshot.enabled` and follow instructions in " +
"migration guide https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots")
"migration guide https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots")

private def eventsBySlicesPubSubSource[Event](
entityType: String,
Expand Down
4 changes: 2 additions & 2 deletions docs/release-train-issue-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Key links:
### Check availability

- [ ] Check [API](https://doc.akka.io/api/akka-persistence-r2dbc/$VERSION$/) documentation
- [ ] Check [reference](https://doc.akka.io/docs/akka-persistence-r2dbc/$VERSION$/) documentation. Check that the reference docs were deployed and show a version warning (see section below on how to fix the version warning).
- [ ] Check [reference](https://doc.akka.io/libraries/akka-persistence-r2dbc/$VERSION$/) documentation. Check that the reference docs were deployed and show a version warning (see section below on how to fix the version warning).
- [ ] Check the release on https://repo.akka.io/maven/com/lightbend/akka/akka-persistence-r2dbc_2.13/$VERSION$/akka-persistence-r2dbc_2.13-$VERSION$.pom

### When everything is on https://repo.akka.io/maven
Expand Down Expand Up @@ -60,6 +60,6 @@ For minor or major releases:

### Afterwards

- [ ] Update [akka-dependencies bom](https://github.com/lightbend/akka-dependencies) and version for [Akka module versions](https://doc.akka.io/docs/akka-dependencies/current/) in [akka-dependencies repo](https://github.com/akka/akka-dependencies)
- [ ] Update [akka-dependencies bom](https://github.com/lightbend/akka-dependencies) and version for [Akka module versions](https://doc.akka.io/libraries/akka-dependencies/current/) in [akka-dependencies repo](https://github.com/akka/akka-dependencies)
- [ ] Update [Akka Projection gRPC samples](https://github.com/akka/akka-projection/tree/main/samples/grpc)
- Close this issue
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ class MigrationTool(system: ActorSystem[_]) {
seqNr <- {
// We could load the timestamp and tags from corresponding event, see R2dbcSnapshotStore.saveAsync,
// but when enabling eventsBySlicesStartingFromSnapshots the sql updates should anyway be run.
// See https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
// See https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
val serializedRow = serializedSnapotRow(selectedSnapshot)
targetSnapshotDao
.store(serializedRow)
Expand Down