Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
kw217 opened this issue Jan 17, 2023 · 5 comments
Open

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

kw217 opened this issue Jan 17, 2023 · 5 comments

Comments

@kw217
Copy link
Contributor

kw217 commented Jan 17, 2023

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 pjfanning added this to the 1.0.0 milestone Jan 17, 2023
@pjfanning
Copy link
Contributor

  • don't forget the pekko name in the jars (akka-actor becomes pekko-actor, etc.)
  • the guide will go into the docs - there is a placeholder for the migration section in there (or at least once an inflight PR is merged)

@kw217
Copy link
Contributor Author

kw217 commented Jan 18, 2023

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
Copy link
Contributor Author

kw217 commented Feb 3, 2023

Example migration (thanks @pjfanning): pjfanning/micrometer-akka#3

@sam-byng
Copy link
Contributor

sam-byng commented Mar 8, 2023

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

  • Flesh out existing parts of migration guide with more details.
  • Address the final three bullets still not covered in issue description.
  • Add clear linking from GitHub homepage to migration guide.
  • Add clear linking from the project website homepage: The migration guide is on the homepage (index.html) but the link is buried down in the Project Information subheading. Since the large proportion of PEKKO users will initially be migrating from AKKA I think that it is important that we place this in a clearer location e.g. the docs 'Getting Started' Guide.
  • Add at link to a clean example migration to this migration guide OR copy snippets of it into the migration guide subsections when we flesh it out.

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

@pjfanning
Copy link
Contributor

pjfanning commented May 28, 2023

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.

@pjfanning pjfanning removed this from the 1.0.0 milestone May 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants