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.

Sign up for GitHub

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

Jump to bottom

Documentation for x/upgrade in-place migrations #8940

Closed
4 tasks
amaury1093 opened this issue Mar 19, 2021 · 0 comments · Fixed by #8967
Closed
4 tasks

Documentation for x/upgrade in-place migrations #8940

amaury1093 opened this issue Mar 19, 2021 · 0 comments · Fixed by #8967
Assignees
@technicallyty
Labels
C:x/upgrade T:Docs Changes and features related to documentation.
Milestone
v0.43

Comments

@amaury1093
Copy link
Contributor

Summary

Add user-friendly documentation for ADR-041.

Problem Definition

No docs for app developers.

Proposal

I believe there should be 2 pages:

  • one targeted at module developers, inside docs/building-modules/upgrade.md
    • covers module ConsensusVersion, and how to add migration scripts
  • one targeted at app developers, inside docs/core-concepts/upgrade.md
    • covers rationale behind it, and what concrete steps to do to enable it (namely: InitChainer stuff and UpgradeHandler stuff).

For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@amaury1093 amaury1093 added T:Docs Changes and features related to documentation. C:x/upgrade labels Mar 19, 2021
@amaury1093 amaury1093 added this to the v0.43 milestone Mar 19, 2021
@alessio alessio mentioned this issue Mar 19, 2021
Closed
@amaury1093 amaury1093 removed their assignment Mar 22, 2021
@technicallyty technicallyty mentioned this issue Mar 23, 2021
Merged
9 tasks
@amaury1093 amaury1093 mentioned this issue Apr 2, 2021
Merged
9 tasks
@aaronc aaronc mentioned this issue Apr 7, 2021
Closed
@mergify mergify bot closed this as completed in #8967 Apr 14, 2021
@aaronc aaronc removed the in-review label Apr 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@technicallyty technicallyty

Labels
C:x/upgrade T:Docs Changes and features related to documentation.
Projects
None yet
Milestone
v0.43
Development

Successfully merging a pull request may close this issue.

documentation for in-place migrations with x/upgrade module cosmos/cosmos-sdk
4 participants
@aaronc @clevinson @amaury1093 @technicallyty