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

docs: re-arrange and clarify migration docs #15575

Merged
merged 10 commits into from
Mar 28, 2023
Merged

docs: re-arrange and clarify migration docs #15575

merged 10 commits into from
Mar 28, 2023

Conversation

julienrbrt
Copy link
Member

Description

Attempts to re-arrange and clarify migration docs.
Comes from the params discussions.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@@ -2,7 +2,13 @@
sidebar_position: 1
---

# Pre-Upgrade Handling
# Migrations
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Put the migrations to perform by a chain under building-apps, what do you think?
Then the migration, more SDK related is under the migration section.
I think it makes sense, but curious about your input.


## Add SDK migration documentation
cp -r ../UPGRADING.md ./docs/migrations/02-upgrading.md
Copy link
Member Author

@julienrbrt julienrbrt Mar 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will render the UPGRADING.md directly on the website.

@julienrbrt julienrbrt enabled auto-merge (squash) March 28, 2023 16:36
@julienrbrt julienrbrt merged commit 2262199 into main Mar 28, 2023
@julienrbrt julienrbrt deleted the julien/migration branch March 28, 2023 16:39
@julienrbrt
Copy link
Member Author

@Mergifyio backport release/v0.47.x

@mergify
Copy link
Contributor

mergify bot commented Mar 28, 2023

backport release/v0.47.x

✅ Backports have been created

@julienrbrt
Copy link
Member Author

backporting to make it coherent.

mergify bot pushed a commit that referenced this pull request Mar 28, 2023
(cherry picked from commit 2262199)

# Conflicts:
#	UPGRADING.md
#	docs/.gitignore
#	docs/post.sh
#	docs/pre.sh
julienrbrt added a commit that referenced this pull request Mar 28, 2023
Co-authored-by: Julien Robert <julien@rbrt.fr>
roy-dydx pushed a commit to dydxprotocol/cosmos-sdk that referenced this pull request Jul 11, 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

Successfully merging this pull request may close these issues.

2 participants