raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

stub of migration documentation (#147)

Browse source
This commit is contained in:
PJ Fanning 2023-02-05 22:15:58 +01:00 • committed by GitHub
parent 64c7ec8fa7
commit bf0a9b3515
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/src/main/paradox/persistence.md
View file

@ -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

17
docs/src/main/paradox/project/migration-guides.md
View file

@ -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.