[incubator-pekko] branch main updated: stub of migration documentation (#147)

[fa...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko.git


The following commit(s) were added to refs/heads/main by this push:
     new bf0a9b3515 stub of migration documentation (#147)
bf0a9b3515 is described below

commit bf0a9b351501f2ad665fcb738c6b14cbe136e361
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Sun Feb 5 22:15:58 2023 +0100

    stub of migration documentation (#147)
---
 docs/src/main/paradox/persistence.md              |  2 +-
 docs/src/main/paradox/project/migration-guides.md | 17 +++++++++++++++--
 2 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/docs/src/main/paradox/persistence.md b/docs/src/main/paradox/persistence.md
index d501a5ac24..b7fea91768 100644
--- a/docs/src/main/paradox/persistence.md
+++ b/docs/src/main/paradox/persistence.md
@@ -8,7 +8,7 @@ For the full documentation of this feature and for new projects see @ref:[Event
 
 ## Module info
 
-To use Pekko Persistence, you must add the following dependency in your project:
+To use Apache Pekko Persistence, you must add the following dependency in your project:
 
 @@dependency[sbt,Maven,Gradle] {
   bomGroup=org.apache.pekko bomArtifact=pekko-bom_$scala.binary.version$ bomVersionSymbols=PekkoVersion
diff --git a/docs/src/main/paradox/project/migration-guides.md b/docs/src/main/paradox/project/migration-guides.md
index 2dfee1570f..029ad79415 100644
--- a/docs/src/main/paradox/project/migration-guides.md
+++ b/docs/src/main/paradox/project/migration-guides.md
@@ -6,8 +6,21 @@ project.description: Apache Pekko version 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 to Pekko
+## Migration to Apache Pekko
 
-TODO
+This is just stub documentation. It will be improved.
 
+* for Pekko jar dependencies, the groupId is "org.apache.pekko" instead of "com.typesafe.akka"
+* the jar names start with "pekko" instead of "akka" - e.g. pekko-actor_2.13.jar instead of akka-actor_2.13.jar 
+* Alpakka equivalent is "pekko-connectors" - e.g. pekko-connectors-kafka_2.13.jar instead of alpakka-kafka_2.13.jar
+* Pekko packages start with "org.apache.pekko" instead of "akka" - e.g. `import org.apache.pekko.actor` instead of `import akka.actor`
+* Where class names have "Akka" in the name, the Pekko ones have "Pekko" - e.g. PekkoException instead of AkkaException
+* Configs in `application.conf` use "pekko" prefix instead of "akka"
 
+We are still investigating the effects of how the package name changes affect the @ref:[Persistence](../persistence.md)
+and @ref:[Cluster](../cluster-usage.md) modules.
+Data persisted with "akka-persistence" may not yet be usable with "pekko-persistence" (or vice versa).
+Akka and Pekko nodes may not be able to form a cluster or messages may not be recognised if passed between nodes
+of different types.
+
+We may be able to provide [Scalafix](https://scalacenter.github.io/scalafix/) scripts to help with migrations.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org