docs: re-arrange and clarify migration docs (#15575)

This commit is contained in:
Julien Robert
2023-03-28 16:39:05 +00:00
committed by GitHub
parent d8a6dcc647
commit 22621995b5
10 changed files with 43 additions and 20 deletions
+1
View File
@@ -19,6 +19,7 @@ docs/docs/tooling/02-depinject.md
docs/docs/tooling/03-confix.md
docs/docs/tooling/04-hubl.md
docs/run-node/04-rosetta.md
docs/migrations/02-upgrading.md
# Misc
.DS_Store
@@ -2,7 +2,17 @@
sidebar_position: 1
---
# Pre-Upgrade Handling
# Application upgrade
:::note
This document describes how to upgrade your application. If you are looking specifically for the changes to perform between SDK versions, see the [SDK migrations documentation](https://docs.cosmos.network/main/migrations/intro).
:::
:::warning
This section is currently incomplete. Track the progress of this document [here](https://github.com/cosmos/cosmos-sdk/issues/11504).
:::
## Pre-Upgrade Handling
Cosmovisor supports custom pre-upgrade handling. Use pre-upgrade handling when you need to implement application config changes that are required in the newer version before you perform the upgrade.
-11
View File
@@ -1,11 +0,0 @@
---
sidebar_position: 1
---
# Introduction to Migrations
This document contains all the migration guides to update your app and modules to the current Cosmos SDK.
1. Chain Upgrade Guide to v0.47:
* See [UPGRADING.md](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/UPGRADING.md) for breaking changes and deprecations upgrade instructions.
* See [Release Notes](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/RELEASE_NOTES.md) and [changelog](https://github.com/cosmos/cosmos-sdk/blob/v0.47.0-rc1/CHANGELOG.md) for the exhaustive list of API and State Machine breaking changes.
+15
View File
@@ -0,0 +1,15 @@
---
sidebar_position: 1
---
# SDK Migrations
To smoothen the update to the latest stable release, the SDK includes a CLI command for hard-fork migrations (under the `<appd> genesis migrate` subcommand).
Additionally, the SDK includes in-place migrations for its core modules. These in-place migrations are useful to migrate between major releases.
* Hard-fork migrations are supported from the last major release to the current one.
* In-place module migrations are supported from the last two major releases to the current one.
Migration from a version older than the last two major releases is not supported.
When migrating from a previous version, refer to the [`UPGRADING.md`](./02-upgrading.md) and the `CHANGELOG.md` of the version you are migrating to.
+1 -1
View File
@@ -1,5 +1,5 @@
{
"label": "Migrations",
"label": "SDK Migrations",
"position": 6,
"link": null
}
+4
View File
@@ -389,6 +389,10 @@ const config = {
from: ["/main/run-node/cosmovisor"],
to: "/main/tooling/cosmovisor",
},
{
from: ["/main/migrations/pre-upgrade"],
to: "/main/building-apps/migrations",
},
],
},
],
+1
View File
@@ -9,4 +9,5 @@ rm -rf docs/run-node/04-rosetta.md
rm -rf docs/architecture
rm -rf docs/spec
rm -rf docs/rfc
rm -rf docs/migrations/02-upgrading.md
rm -rf versioned_docs versioned_sidebars versions.json
+4 -1
View File
@@ -33,4 +33,7 @@ cp -r ./architecture ./docs
cp -r ./spec ./docs
## Add rfc documentation
cp -r ./rfc ./docs
cp -r ./rfc ./docs
## Add SDK migration documentation
cp -r ../UPGRADING.md ./docs/migrations/02-upgrading.md