diff --git a/docs/src/main/paradox/index.md b/docs/src/main/paradox/index.md index 1a37c703fd..1f6a2417b6 100644 --- a/docs/src/main/paradox/index.md +++ b/docs/src/main/paradox/index.md @@ -19,5 +19,6 @@ * [additional/deploy](additional/deploy.md) * [project/index](project/project-index.md) * [classic](index-classic.md) +* [migration](migration/index.md) @@@ diff --git a/docs/src/main/paradox/migration/index.md b/docs/src/main/paradox/migration/index.md new file mode 100644 index 0000000000..d4e9235e39 --- /dev/null +++ b/docs/src/main/paradox/migration/index.md @@ -0,0 +1,14 @@ +--- +project.description: Apache Pekko version migration guides. +--- +# Migration Guides + + +@@toc { depth=1 } + +@@@ index + +* [Migration Guide from Akka to Apache Pekko 1.0.x](migration-guide-akka-1.0.x.md) +* [Migration Guide from Apache Pekko 1.0.x to 1.1.x](migration-guide-1.0.x-1.1.x.md) + +@@@ diff --git a/docs/src/main/paradox/project/migration-guide-1.0.x-1.1.x.md b/docs/src/main/paradox/migration/migration-guide-1.0.x-1.1.x.md similarity index 98% rename from docs/src/main/paradox/project/migration-guide-1.0.x-1.1.x.md rename to docs/src/main/paradox/migration/migration-guide-1.0.x-1.1.x.md index 30acd16ab9..1a9a6323c9 100644 --- a/docs/src/main/paradox/project/migration-guide-1.0.x-1.1.x.md +++ b/docs/src/main/paradox/migration/migration-guide-1.0.x-1.1.x.md @@ -1,7 +1,7 @@ --- project.description: Migrating to Apache Pekko 1.1. --- -# Migration Guide 1.0.x to 1.1.x +# Migration from Apache Pekko 1.0.x to 1.1.x Apache Pekko 1.1.x is binary backwards compatible with 1.0.x with the ordinary exceptions listed in the @ref:[Binary Compatibility Rules](../common/binary-compatibility-rules.md). diff --git a/docs/src/main/paradox/project/migration-guides.md b/docs/src/main/paradox/migration/migration-guide-akka-1.0.x.md similarity index 94% rename from docs/src/main/paradox/project/migration-guides.md rename to docs/src/main/paradox/migration/migration-guide-akka-1.0.x.md index 82e01a11b4..104980725a 100644 --- a/docs/src/main/paradox/project/migration-guides.md +++ b/docs/src/main/paradox/migration/migration-guide-akka-1.0.x.md @@ -1,12 +1,10 @@ --- project.description: Apache Pekko version migration guides. --- -# Migration Guides - Apache Pekko is based on the latest version of Akka in the v2.6.x series. If migrating from an earlier version of Akka, please [migrate to Akka 2.6](https://doc.akka.io/docs/akka/current/project/migration-guides.html) before migrating to Pekko. -## Migration from Akka to Apache Pekko +# Migration from Akka to Apache Pekko These migration notes are designed for users migrating from Akka 2.6 to Pekko 1.0 and assume a basic level of Akka experience. Please feel free to submit an issue or a patch if you feel like the notes can be improved. @@ -23,7 +21,7 @@ These migration notes are designed for users migrating from Akka 2.6 to Pekko 1. * With @ref:[Classic Remoting](../remoting.md), Akka defaults to 2552, while Pekko defaults to 7355. * With @ref:[Artery Remoting](../remoting-artery.md), Akka defaults to 25520, while Pekko defaults to 17355. -### Dependency Changes +## Dependency Changes * The Scala 2.13/Scala 3 versions of Pekko no longer include [scala-java8-compat](https://github.com/scala/scala-java8-compat) as a dependency. This means if you were relying on `scala-java8-compat` along with Scala 2.12/Scala 3 as a transitive dependency that it's recommended to migrate to using [`scala.jdk` instead](https://github.com/scala/scala-java8-compat#do-you-need-this). @@ -39,17 +37,8 @@ These migration notes are designed for users migrating from Akka 2.6 to Pekko 1. * reactivestreams is upgraded to 1.0.4. * pekko-protobuf-v3 is based on protobuf-java 3.16.3. -### Miscellaneous Notes +## Miscellaneous Notes Data persisted with "akka-persistence" is usable with "pekko-persistence" and vice versa (@ref:[Persistence](../persistence.md)). There is one [issue](https://github.com/apache/incubator-pekko/pull/837) that is fixed in v1.0.3-M1 (related to persisted snapshots - for which there is a [workaround](https://github.com/scullxbones/pekko-persistence-mongo/pull/14#issuecomment-1847223850)). Early releases of Apache Pekko could not be used to allow Akka and Pekko nodes to combine to form a @ref:[cluster](../cluster-usage.md). The v1.0.3-M1 @ref:[release](../release-notes/index.md) has experimental support that we would appreciate users to try out in test environments ([wiki page](https://cwiki.apache.org/confluence/display/PEKKO/Pekko+Akka+Compatibility)). - - -@@toc { depth=1 } - -@@@ index - -* [migration-guide-1.0.x-1.1.x](migration-guide-1.0.x-1.1.x.md) - -@@@ diff --git a/docs/src/main/paradox/project/project-index.md b/docs/src/main/paradox/project/project-index.md index 08b4cb3370..ad073d3a20 100644 --- a/docs/src/main/paradox/project/project-index.md +++ b/docs/src/main/paradox/project/project-index.md @@ -12,7 +12,6 @@ * [../additional/ide](../additional/ide.md) * [immutable](immutable.md) * [../additional/osgi](../additional/osgi.md) -* [migration-guides](migration-guides.md) * [rolling-update](rolling-update.md) * [issue-tracking](issue-tracking.md) * [licenses](licenses.md) diff --git a/docs/src/main/paradox/release-notes/index.md b/docs/src/main/paradox/release-notes/index.md index 8826580541..ea567db385 100644 --- a/docs/src/main/paradox/release-notes/index.md +++ b/docs/src/main/paradox/release-notes/index.md @@ -47,7 +47,7 @@ a license that is not compatible with Open Source usage. Apache Pekko has changed the package names, among other changes. Config names have changed to use `pekko` instead of `akka` in their names. The default ports for pekko-remote have changed to avoid clashing with the akka-remote -defaults. Users switching from Akka to Pekko should read our @ref:[Migration Guide](../project/migration-guides.md). +defaults. Users switching from Akka to Pekko should read our @ref:[Migration Guide](../migration/index.md). Generally, we have tried to make it as easy as possible to switch existing Akka 2.6 based projects over to using Pekko 1.0. diff --git a/project/ProjectIndexGenerator.scala b/project/ProjectIndexGenerator.scala index d727d49983..4443328e34 100644 --- a/project/ProjectIndexGenerator.scala +++ b/project/ProjectIndexGenerator.scala @@ -40,7 +40,6 @@ object ProjectIndexGenerator extends AutoPlugin { "../additional/ide.md", "immutable.md", "../additional/osgi.md", - "migration-guides.md", "rolling-update.md", "issue-tracking.md", "licenses.md")