From 647aea8a4ad0f08bdc9fa31392d13544485d3427 Mon Sep 17 00:00:00 2001 From: Enno Runne <458526+ennru@users.noreply.github.com> Date: Mon, 23 Sep 2024 11:23:20 +0200 Subject: [PATCH 1/2] docs: revise URL structure (libraries) --- README.md | 4 ++-- build.sbt | 14 +++++++------- core/src/main/resources/reference.conf | 2 +- .../akka/persistence/r2dbc/R2dbcSettings.scala | 4 ++-- .../r2dbc/query/javadsl/R2dbcReadJournal.scala | 4 ++-- .../r2dbc/query/scaladsl/R2dbcReadJournal.scala | 6 +++--- docs/release-train-issue-template.md | 4 ++-- .../r2dbc/migration/MigrationTool.scala | 2 +- 8 files changed, 20 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 888e99b6..bfe38097 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/build.sbt b/build.sbt index fa9e6026..8062d27b 100644 --- a/build.sbt +++ b/build.sbt @@ -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"), @@ -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}/", diff --git a/core/src/main/resources/reference.conf b/core/src/main/resources/reference.conf index c9867425..a739df7b 100644 --- a/core/src/main/resources/reference.conf +++ b/core/src/main/resources/reference.conf @@ -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 } } diff --git a/core/src/main/scala/akka/persistence/r2dbc/R2dbcSettings.scala b/core/src/main/scala/akka/persistence/r2dbc/R2dbcSettings.scala index 6ac03e9c..05d7e746 100644 --- a/core/src/main/scala/akka/persistence/r2dbc/R2dbcSettings.scala +++ b/core/src/main/scala/akka/persistence/r2dbc/R2dbcSettings.scala @@ -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) @@ -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 { diff --git a/core/src/main/scala/akka/persistence/r2dbc/query/javadsl/R2dbcReadJournal.scala b/core/src/main/scala/akka/persistence/r2dbc/query/javadsl/R2dbcReadJournal.scala index 342e2692..e49c258b 100644 --- a/core/src/main/scala/akka/persistence/r2dbc/query/javadsl/R2dbcReadJournal.scala +++ b/core/src/main/scala/akka/persistence/r2dbc/query/javadsl/R2dbcReadJournal.scala @@ -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, @@ -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, diff --git a/core/src/main/scala/akka/persistence/r2dbc/query/scaladsl/R2dbcReadJournal.scala b/core/src/main/scala/akka/persistence/r2dbc/query/scaladsl/R2dbcReadJournal.scala index e47a9779..5dfc49b5 100644 --- a/core/src/main/scala/akka/persistence/r2dbc/query/scaladsl/R2dbcReadJournal.scala +++ b/core/src/main/scala/akka/persistence/r2dbc/query/scaladsl/R2dbcReadJournal.scala @@ -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, @@ -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, @@ -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, diff --git a/docs/release-train-issue-template.md b/docs/release-train-issue-template.md index 438c3e12..60a8b305 100644 --- a/docs/release-train-issue-template.md +++ b/docs/release-train-issue-template.md @@ -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 @@ -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 diff --git a/migration/src/main/scala/akka/persistence/r2dbc/migration/MigrationTool.scala b/migration/src/main/scala/akka/persistence/r2dbc/migration/MigrationTool.scala index 35b5f9d7..69fcaad7 100644 --- a/migration/src/main/scala/akka/persistence/r2dbc/migration/MigrationTool.scala +++ b/migration/src/main/scala/akka/persistence/r2dbc/migration/MigrationTool.scala @@ -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) From 04c3d67f056720f283cd984fc866b482d9eae4c7 Mon Sep 17 00:00:00 2001 From: Enno Runne <458526+ennru@users.noreply.github.com> Date: Mon, 23 Sep 2024 11:39:06 +0200 Subject: [PATCH 2/2] Release template --- docs/release-train-issue-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-train-issue-template.md b/docs/release-train-issue-template.md index 60a8b305..ee663b0a 100644 --- a/docs/release-train-issue-template.md +++ b/docs/release-train-issue-template.md @@ -40,7 +40,7 @@ Key links: ``` cd ~/www git status - git add docs/akka-persistence-r2dbc/current docs/akka-persistence-r2dbc/$VERSION$ + git add libraries/akka-persistence-r2dbc/current libraries/akka-persistence-r2dbc/$VERSION$ git add api/akka-persistence-r2dbc/current api/akka-persistence-r2dbc/$VERSION$ git commit -m "Akka Persistence R2DBC $VERSION$" ```