apache / pekko

Build highly concurrent, distributed, and resilient message-driven applications using Java/Scala
https://pekko.apache.org/
Apache License 2.0
1.21k stars 148 forks source link

Create a migration guide to migrate from Akka to Pekko #109

Open kw217 opened 1 year ago

kw217 commented 1 year ago

Create a migration guide explaining to a user of Akka how to migrate their project to Pekko.

We hope to automate as much of this as possible under #22 but first we need to determine the steps and lay them out so early adopters can follow them and gain experience.

This should be documented in docs/src/main/paradox/project/migration-guide-akka-pekko.md, linked from migration-guides.md in the same location, and also linked prominently from the GitHub homepage README.md and the project homepage docs/src/main/paradox/index.md.

Steps include:

pjfanning commented 1 year ago
kw217 commented 1 year ago

Cool, thanks - added that to the description.

Docs location - presumably you're referring to https://github.com/apache/incubator-pekko/blob/main/docs/src/main/paradox/project/migration-guides.md which just got updated? Perfect. Should we just put the migration guide in that doc, rather than a separate doc linked from there?

kw217 commented 1 year ago

Example migration (thanks @pjfanning): https://github.com/pjfanning/micrometer-akka/pull/3

sam-byng commented 1 year ago

Just reviewing the status of this issue, I think that the next steps on this card are to complete the following TODOs:

Following the above, test out the migration guide to identify remaining gaps/issues.

pjfanning commented 1 year ago

We have a migration guide. It's not perfect but we can adjust it. Please raise PRs if you want to suggest changes - or comment on this issue.

https://pekko.apache.org/docs/pekko/current//project/migration-guides.html

Removing the milestone as I want to not have open issues in it.