Skip to content

Commit 96f2fe5

Browse files
authored
docs: revise URL structure (libraries) (#601)
1 parent 45a2bc4 commit 96f2fe5

File tree

8 files changed

+21
-21
lines changed

8 files changed

+21
-21
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

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

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

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

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

1212
## Project status
1313

build.sbt

+7-7
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ inThisBuild(
1010
Seq(
1111
organization := "com.lightbend.akka",
1212
organizationName := "Lightbend Inc.",
13-
homepage := Some(url("https://doc.akka.io/docs/akka-persistence-r2dbc/current")),
13+
homepage := Some(url("https://doc.akka.io/libraries/akka-persistence-r2dbc/current")),
1414
scmInfo := Some(
1515
ScmInfo(
1616
url("https://github.com/akka/akka-persistence-r2dbc"),
@@ -137,21 +137,21 @@ lazy val docs = project
137137
previewPath := (Paradox / siteSubdirName).value,
138138
Preprocess / siteSubdirName := s"api/akka-persistence-r2dbc/${projectInfoVersion.value}",
139139
Preprocess / sourceDirectory := (LocalRootProject / ScalaUnidoc / unidoc / target).value,
140-
Paradox / siteSubdirName := s"docs/akka-persistence-r2dbc/${projectInfoVersion.value}",
140+
Paradox / siteSubdirName := s"libraries/akka-persistence-r2dbc/${projectInfoVersion.value}",
141141
paradoxGroups := Map(
142142
"Language" -> Seq("Java", "Scala"),
143143
"Dialect" -> Seq("Postgres", "Yugabyte", "H2", "SQLServer")),
144144
Compile / paradoxProperties ++= Map(
145-
"project.url" -> "https://doc.akka.io/docs/akka-persistence-r2dbc/current/",
146-
"canonical.base_url" -> "https://doc.akka.io/docs/akka-persistence-r2dbc/current",
145+
"project.url" -> "https://doc.akka.io/libraries/akka-persistence-r2dbc/current/",
146+
"canonical.base_url" -> "https://doc.akka.io/libraries/akka-persistence-r2dbc/current",
147147
"akka.version" -> Dependencies.AkkaVersion,
148148
"h2.version" -> Dependencies.H2Version,
149149
"r2dbc-h2.version" -> Dependencies.R2dbcH2Version,
150150
"scala.version" -> scalaVersion.value,
151151
"scala.binary.version" -> scalaBinaryVersion.value,
152-
"extref.akka.base_url" -> s"https://doc.akka.io/docs/akka/${Dependencies.AkkaVersionInDocs}/%s",
153-
"extref.akka-docs.base_url" -> s"https://doc.akka.io/docs/akka/${Dependencies.AkkaVersionInDocs}/%s",
154-
"extref.akka-projection.base_url" -> s"https://doc.akka.io/docs/akka-projection/${Dependencies.AkkaProjectionVersionInDocs}/%s",
152+
"extref.akka.base_url" -> s"https://doc.akka.io/libraries/akka-core/${Dependencies.AkkaVersionInDocs}/%s",
153+
"extref.akka-docs.base_url" -> s"https://doc.akka.io/libraries/akka-core/${Dependencies.AkkaVersionInDocs}/%s",
154+
"extref.akka-projection.base_url" -> s"https://doc.akka.io/libraries/akka-projection/${Dependencies.AkkaProjectionVersionInDocs}/%s",
155155
"extref.java-docs.base_url" -> "https://docs.oracle.com/en/java/javase/11/%s",
156156
"scaladoc.scala.base_url" -> s"https://www.scala-lang.org/api/current/",
157157
"scaladoc.akka.persistence.r2dbc.base_url" -> s"/${(Preprocess / siteSubdirName).value}/",

core/src/main/resources/reference.conf

+1-1
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ akka.persistence.r2dbc {
164164
# currentEventsBySlicesStartingFromSnapshots are used. That has a small overhead when storing
165165
# snapshots because the timestamp and tags of the corresponding event is retrieved when storing
166166
# a snapshot.
167-
# See also https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
167+
# See also https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
168168
enabled = false
169169
}
170170
}

core/src/main/scala/akka/persistence/r2dbc/R2dbcSettings.scala

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ object R2dbcSettings {
3636
"Database dialect config has moved from 'akka.persistence.r2dbc.dialect' into the connection-factory block, " +
3737
"the old 'dialect' config entry must be removed, " +
3838
"see akka-persistence-r2dbc documentation for details on the new configuration scheme: " +
39-
"https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html")
39+
"https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html")
4040
}
4141

4242
val schema: Option[String] = Option(config.getString("schema")).filterNot(_.trim.isEmpty)
@@ -102,7 +102,7 @@ object R2dbcSettings {
102102
"The Akka Persistence R2DBC database config scheme has changed, the config needs to be updated " +
103103
"to choose database dialect using the connection-factory block, " +
104104
"see akka-persistence-r2dbc documentation for details on the new configuration scheme: " +
105-
"https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html")
105+
"https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html")
106106
}
107107
Vector(ConnectionFactorySettings(config.getConfig("connection-factory")))
108108
} else {

core/src/main/scala/akka/persistence/r2dbc/query/javadsl/R2dbcReadJournal.scala

+2-2
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ final class R2dbcReadJournal(delegate: scaladsl.R2dbcReadJournal)
117117
*
118118
* To use `currentEventsBySlicesStartingFromSnapshots` you must enable configuration
119119
* `akka.persistence.r2dbc.query.start-from-snapshot.enabled` and follow instructions in migration guide
120-
* https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
120+
* https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
121121
*/
122122
override def currentEventsBySlicesStartingFromSnapshots[Snapshot, Event](
123123
entityType: String,
@@ -141,7 +141,7 @@ final class R2dbcReadJournal(delegate: scaladsl.R2dbcReadJournal)
141141
*
142142
* To use `eventsBySlicesStartingFromSnapshots` you must enable configuration
143143
* `akka.persistence.r2dbc.query.start-from-snapshot.enabled` and follow instructions in migration guide
144-
* https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
144+
* https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
145145
*/
146146
override def eventsBySlicesStartingFromSnapshots[Snapshot, Event](
147147
entityType: String,

core/src/main/scala/akka/persistence/r2dbc/query/scaladsl/R2dbcReadJournal.scala

+3-3
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ final class R2dbcReadJournal(system: ExtendedActorSystem, config: Config, cfgPat
271271
*
272272
* To use `currentEventsBySlicesStartingFromSnapshots` you must enable configuration
273273
* `akka.persistence.r2dbc.query.start-from-snapshot.enabled` and follow instructions in migration guide
274-
* https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
274+
* https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
275275
*/
276276
override def currentEventsBySlicesStartingFromSnapshots[Snapshot, Event](
277277
entityType: String,
@@ -328,7 +328,7 @@ final class R2dbcReadJournal(system: ExtendedActorSystem, config: Config, cfgPat
328328
*
329329
* To use `eventsBySlicesStartingFromSnapshots` you must enable configuration
330330
* `akka.persistence.r2dbc.query.start-from-snapshot.enabled` and follow instructions in migration guide
331-
* https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
331+
* https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
332332
*/
333333
override def eventsBySlicesStartingFromSnapshots[Snapshot, Event](
334334
entityType: String,
@@ -417,7 +417,7 @@ final class R2dbcReadJournal(system: ExtendedActorSystem, config: Config, cfgPat
417417
throw new IllegalArgumentException(
418418
s"To use $methodName you must enable " +
419419
"configuration `akka.persistence.r2dbc.query.start-from-snapshot.enabled` and follow instructions in " +
420-
"migration guide https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots")
420+
"migration guide https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots")
421421

422422
private def eventsBySlicesPubSubSource[Event](
423423
entityType: String,

docs/release-train-issue-template.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Key links:
3030
### Check availability
3131

3232
- [ ] Check [API](https://doc.akka.io/api/akka-persistence-r2dbc/$VERSION$/) documentation
33-
- [ ] 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).
33+
- [ ] 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).
3434
- [ ] 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
3535

3636
### When everything is on https://repo.akka.io/maven
@@ -40,7 +40,7 @@ Key links:
4040
```
4141
cd ~/www
4242
git status
43-
git add docs/akka-persistence-r2dbc/current docs/akka-persistence-r2dbc/$VERSION$
43+
git add libraries/akka-persistence-r2dbc/current libraries/akka-persistence-r2dbc/$VERSION$
4444
git add api/akka-persistence-r2dbc/current api/akka-persistence-r2dbc/$VERSION$
4545
git commit -m "Akka Persistence R2DBC $VERSION$"
4646
```
@@ -60,6 +60,6 @@ For minor or major releases:
6060
6161
### Afterwards
6262
63-
- [ ] 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)
63+
- [ ] 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)
6464
- [ ] Update [Akka Projection gRPC samples](https://github.com/akka/akka-projection/tree/main/samples/grpc)
6565
- Close this issue

migration/src/main/scala/akka/persistence/r2dbc/migration/MigrationTool.scala

+1-1
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,7 @@ class MigrationTool(system: ActorSystem[_]) {
327327
seqNr <- {
328328
// We could load the timestamp and tags from corresponding event, see R2dbcSnapshotStore.saveAsync,
329329
// but when enabling eventsBySlicesStartingFromSnapshots the sql updates should anyway be run.
330-
// See https://doc.akka.io/docs/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
330+
// See https://doc.akka.io/libraries/akka-persistence-r2dbc/current/migration-guide.html#eventsBySlicesStartingFromSnapshots
331331
val serializedRow = serializedSnapotRow(selectedSnapshot)
332332
targetSnapshotDao
333333
.store(serializedRow)

0 commit comments

Comments
 (0)