[Feature Request] Improve Upgradability documentation

[movekevin]

trafficstars

1. Let's merge https://aptos.dev/guides/move-guides/upgrading-move-code into the Move book, now that it's been ported over to aptos-core thanks to @wrwg
2. We should add more examples and may be create a tutorial either in the Move book or aptos.dev for upgrading modules (what devs can do or can't do)

[clay-aptos]

Thanks, @movekevin! I assume I will work with you directly. If not, please co-assign the respective source (expert) for this. Thanks again!

[wrwg]

I think the definition of compatibility belongs into the code module and then should be linked from the guide. (It is a guide not reference.)

[clay-aptos]

Giving this a low priority until we get some movement from @movekevin .

[clay-aptos]

Per Move Workshop #2: Few smart contracts should be immutable, namely simple libraries. Upgrading can be difficult, requiring migrating users from the old smart contract to the new. This can be mitigated by modular design.

[github-actions[bot]]

This issue is stale because it has been open 45 days with no activity. Remove the stale label or comment - otherwise this will be closed in 15 days.

[clay-aptos]

Hi @movekevin , who can I work with to get answers to questions you posed when filing this issue? Thanks!

[movekevin]

I've added a lot of these already in the Move book. The next step I think is to write a thorough tutorial on upgrading move tutorials that run through a lot of these rules to make them clear/easier to follow.

[clay-aptos]

Thanks for asking Gerben to help, Kevin!

[wrwg]

Also move upgradability page into Aptos Move book, as we are with this.

[movekevin]

I've updated the description to reflect most recent developments (Move book being ported over) and related discussion

[clay-aptos]

Also move upgradability page into Aptos Move book, as we are with this.

Just confirming that should be done upstream in the aptos-main branch of the Move Lang repo still? https://github.com/move-language/move/tree/aptos-main/language/documentation/book

Thanks.

[movekevin]

Also move upgradability page into Aptos Move book, as we are with this.

Just confirming that should be done upstream in the aptos-main branch of the Move Lang repo still? https://github.com/move-language/move/tree/aptos-main/language/documentation/book

Thanks.

No. @wrwg already ported the Move book over into our repo

[wrwg]

Actually @clay-aptos did import it (on my ask), I worked on the tutorial. Clay why do you think we need to push upstream? Upgradability is aptos specific. I care together with the Move partners (weekly meetings) if there is anything to push upstream. There hasn't been any change in the shared Move language since 1 1/2 years.

[clay-aptos]

Actually @clay-aptos did import it (on my ask), I worked on the tutorial. Clay why do you think we need to push upstream? Upgradability is aptos specific. I care together with the Move partners (weekly meetings) if there is anything to push upstream. There hasn't been any change in the shared Move language since 1 1/2 years.

Ah, I thought you wanted to update the Move Book contents. And I thought those were maintained upstream and copied (manually by me the last time) from the Move Lang repo to ours. If this can go in our version and not be overwritten, please ignore me. Thanks!

[junkil-park]

Here is a PR to migrate the existing upgradability doc into the Move Book: https://github.com/aptos-labs/aptos-core/pull/7346 as the first step to improving the upgradability documentation.

[github-actions[bot]]

This issue is stale because it has been open 45 days with no activity. Remove the stale label or comment - otherwise this will be closed in 15 days.

[movekevin]

Assigning to @vusirikala who's working on some really cool tutorials for deploying and upgrading modules

[github-actions[bot]]

This issue is stale because it has been open 45 days with no activity. Remove the stale label or comment - otherwise this will be closed in 15 days.