Issue #109: Update migration guide #249
Conversation
sam-byng
force-pushed
the
sambyng/update-mig-guide
branch
from
81b926b
to
a606350
Compare
sam-byng
force-pushed
the
sambyng/update-mig-guide
branch
from
00c31fc
to
8340cdc
Compare
|
Looks like all the comments have been addressed - can this be approved and merged? |
|
Checking this now. @pjfanning Cna you also check since we require your approval for PR to be merged. |
|
I must admit to not liking the categorisation of the changes and the duplication of the changes because of the artificial categorisation. |
Can you rephrase, looks fine to me? |
| * Configs in `application.conf` use "pekko" prefix instead of "akka" | ||
|
|
||
| In config files: | ||
| * Configs use `pekko` prefix instead of `akka` |
There was a problem hiding this comment.
why remove the reference to 'application.conf' ?
There was a problem hiding this comment.
To be more accurate we could use *.conf instead since some conf files are reference.conf and others are applciation.conf.
in fact from checking the codebase it should all be reference.conf, after all the idea is that reference.conf is whats used for libraries and application.conf is whats used for applications.
There was a problem hiding this comment.
it's a migration guide for users migrating their own code bases - they will be updating their own application.conf files
some lib maintainers might have reference.conf files
I suppose, some users use '.json' files for configs as well (because typesafe config supports those too).
I would still prefer if this section, tries to name some of the more common config files to help out users to know what to look for - imagaine if the Akka based app that is being migrated was written 5 years ago and the original writers have moved on.
There was a problem hiding this comment.
it's a migration guide for users migrating their own code bases - they will be updating their own application.conf files
Right but its also relevant to libraries which integrate with Pekko, in which case they would be dealing with reference.conf files and not application.conf. Not all users are applications.
I suppose, some users use '.json' files for configs as well (because typesafe config supports those too).
And also *.prop files too which afaik are compatible with HOCON format.
I would still prefer if this section, tries to name some of the more common config files to help out users to know what to look for - imagaine if the Akka based app that is being migrated was written 5 years ago and the original writers have moved on.
In that case the easiest thing would be to search for akka prefix in files that are known to hold configurations which would be *.conf/*.prop and *.json.
| * Where class names have "Akka" in the name, the Pekko ones have "Pekko" - e.g. `PekkoException` instead of `AkkaException` | ||
| * Configs use `pekko` prefix instead of `akka` | ||
|
|
||
| In Documentation: |
There was a problem hiding this comment.
I think this does not apply to migration use case. It's useful advice to people contributing code to Pekko - but it is not really something that someone migrating their company's projects needs to know about.
| In Documentation: | ||
| * Where appropriate, text should refer to `Pekko` instead of `Akka` | ||
| * URLs linking to files in https://doc.akka.io/docs/akka/ should instead point at https://pekko.apache.org/docs/pekko/ | ||
|
|
||
| * We have changed the default ports used by the pekko-remote module. |
There was a problem hiding this comment.
this port information is useful but it is now sort of orphaned by the artificial breaking up of the migration info into categories
there are not so many bullet points that we need to split it up like this - especially when we then stick some of the bullet points off in 'no category'
|
|
||
| ## TBC: | ||
| We are still investigating the effects of how the package name changes affect the @ref:[Persistence](../persistence.md) |
There was a problem hiding this comment.
See https://lists.apache.org/thread/v7c08l4bn66o4o2go0h7xzzl8pz0tr6p
I can update this section in an independent PR
#109: Update migration guide based on experience working with issue #243