Open
Description
opened on Mar 30, 2022
Summary of Bug
The current upgrade guides and docs are not helpful for projects as:
- docs are scattered across different files (In-Place Store Migrations, Upgrading Modules, Migrations Section, Upgrade Module spec, Cosmovisor)
- it doesn't handle the cases of planned vs unplanned upgrades
- it doesn't handle the cases of running cosmovisor vs not using cosmovisor
- it doesn't handle the cases of automated vs manual upgrades
- it doesn't contain documentation in case of automated upgrade failure
- it doesn't have any explanation of the
migrate
command. What is it used for? Is it outdated? - it doesn't have any reference to the
pre-upgrade
command. What is it used for? - it doesn't contain how-to guides for adding new modules vs updating existing modules
- it doesn't handle cases of adding new params vs changing existing params
- it doesn't contain documentation or a reference on what to do with IBC connections after upgrades. This is located in the IBC docs but not referenced in the SDK
Version
master
Proposal
Rewrite the current Migrations
section on the SDK docs and create a go-to Upgrade guide that covers everything
For Admin Use
- Not duplicate issue
- Appropriate labels applied
- Appropriate contributors tagged
- Contributor assigned/self-assigned
Activity