Skip to content
This repository has been archived by the owner on May 30, 2024. It is now read-only.

Ref docs for runtime_upgrades #55

Closed
Tracked by #39
juangirini opened this issue Nov 9, 2023 · 1 comment · Fixed by paritytech/polkadot-sdk#1554
Closed
Tracked by #39

Ref docs for runtime_upgrades #55

juangirini opened this issue Nov 9, 2023 · 1 comment · Fixed by paritytech/polkadot-sdk#1554
Assignees
@liamaharon

Comments

@juangirini
Copy link

juangirini commented Nov 9, 2023 •
edited
Loading

Create the reference docs as part of the Developer Hub -> https://github.com/paritytech/polkadot-sdk/blob/9c2b3eaa8c05f4f25809e87f1890679261cd1e03/developer-hub/src/reference_docs/mod.rs#L94

The focus should be: Learn about all the advance ways to test your coordinate a runtime upgrade and data migration.
@juangirini juangirini mentioned this issue Nov 9, 2023
Open
@juangirini juangirini changed the title frame_runtime_migration @liamaharon Ref docs for frame_runtime_migration Nov 9, 2023
@juangirini juangirini moved this to Todo in Polkadot SDK Docs Nov 10, 2023
@juangirini juangirini mentioned this issue Nov 14, 2023
Open
@liamaharon liamaharon moved this from Todo to In Progress in Polkadot SDK Docs Nov 15, 2023
@liamaharon
Copy link

I'm going to make this reference docs for Runtime Upgrades, which encompasses migrations.

So it'll also supersede this page: https://docs.substrate.io/maintain/runtime-upgrades/

@liamaharon liamaharon changed the title Ref docs for frame_runtime_migration Ref docs for runtime_upgrades Nov 29, 2023
@liamaharon liamaharon moved this from In Progress to Review in Polkadot SDK Docs Nov 30, 2023
@liamaharon liamaharon mentioned this issue Nov 30, 2023
Merged
2 tasks
github-merge-queue bot pushed a commit to paritytech/polkadot-sdk that referenced this issue Feb 28, 2024
@liamaharon @kianenigma
@juangirini @ggwpez @codekitz
Runtime Upgrade ref docs and Single Block Migration example pallet (#…
12ce4f7 
…1554)

Closes paritytech/polkadot-sdk-docs#55

- Changes 'current storage version' terminology to less ambiguous
'in-code storage version' (suggestion by @ggwpez)
- Adds a new example pallet `pallet-example-single-block-migrations`
- Adds a new reference doc to replace
https://docs.substrate.io/maintain/runtime-upgrades/ (temporarily living
in the pallet while we wait for developer hub PR to merge)
- Adds documentation for the `storage_alias` macro
- Improves `trait Hooks` docs 
- Improves `trait GetStorageVersion` docs
- Update the suggested patterns for using `VersionedMigration`, so that
version unchecked migrations are never exported
- Prevents accidental usage of version unchecked migrations in runtimes

paritytech/substrate#14421 (comment)
- Unversioned migration code is kept inside `mod version_unchecked`,
versioned code is kept in `pub mod versioned`
- It is necessary to use modules to limit visibility because the inner
migration must be `pub`. See
rust-lang/rust#30905 and

https://internals.rust-lang.org/t/lang-team-minutes-private-in-public-rules/4504/40
for more.

### todo

- [x] move to reference docs to proper place within sdk-docs (now that
#2102 is merged)
- [x] prdoc

---------

Co-authored-by: Kian Paimani <[email protected]>
Co-authored-by: Juan <[email protected]>
Co-authored-by: Oliver Tale-Yazdi <[email protected]>
Co-authored-by: command-bot <>
Co-authored-by: gupnik <[email protected]>
@github-project-automation github-project-automation bot moved this from Review to Done in Polkadot SDK Docs Feb 28, 2024
bgallois pushed a commit to duniter/duniter-polkadot-sdk that referenced this issue Mar 25, 2024
@liamaharon @kianenigma
@juangirini @ggwpez @codekitz
Runtime Upgrade ref docs and Single Block Migration example pallet (p…
0cf9a38 
…aritytech#1554)

Closes paritytech/polkadot-sdk-docs#55

- Changes 'current storage version' terminology to less ambiguous
'in-code storage version' (suggestion by @ggwpez)
- Adds a new example pallet `pallet-example-single-block-migrations`
- Adds a new reference doc to replace
https://docs.substrate.io/maintain/runtime-upgrades/ (temporarily living
in the pallet while we wait for developer hub PR to merge)
- Adds documentation for the `storage_alias` macro
- Improves `trait Hooks` docs 
- Improves `trait GetStorageVersion` docs
- Update the suggested patterns for using `VersionedMigration`, so that
version unchecked migrations are never exported
- Prevents accidental usage of version unchecked migrations in runtimes

paritytech/substrate#14421 (comment)
- Unversioned migration code is kept inside `mod version_unchecked`,
versioned code is kept in `pub mod versioned`
- It is necessary to use modules to limit visibility because the inner
migration must be `pub`. See
rust-lang/rust#30905 and

https://internals.rust-lang.org/t/lang-team-minutes-private-in-public-rules/4504/40
for more.

### todo

- [x] move to reference docs to proper place within sdk-docs (now that
paritytech#2102 is merged)
- [x] prdoc

---------

Co-authored-by: Kian Paimani <[email protected]>
Co-authored-by: Juan <[email protected]>
Co-authored-by: Oliver Tale-Yazdi <[email protected]>
Co-authored-by: command-bot <>
Co-authored-by: gupnik <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@liamaharon liamaharon

Labels
None yet
Projects
Polkadot SDK Docs
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Runtime Upgrade ref docs and Single Block Migration example pallet paritytech/polkadot-sdk
2 participants
@juangirini @liamaharon