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

docs: add changeover procedure #1123

Merged
merged 13 commits into from
Jul 18, 2023
Merged

docs: add changeover procedure #1123

merged 13 commits into from
Jul 18, 2023

Conversation

MSalopek
Copy link
Contributor

Description

Closes: #1069

Add docs for changeover procedure.

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 docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue 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 docs: prefix in the PR title
  • Confirmed all author checklist items have been addressed
  • Confirmed that this PR only changes documentation
  • Reviewed content for consistency
  • Reviewed content for spelling and grammar
  • Tested instructions (if applicable)
  • Checked that the documentation website can be built and deployed successfully (run make build-docs)

@MSalopek MSalopek self-assigned this Jul 10, 2023
@MSalopek MSalopek marked this pull request as ready for review July 10, 2023 15:18
@MSalopek MSalopek requested a review from a team as a code owner July 10, 2023 15:18
shaspitz
shaspitz reviewed Jul 13, 2023
View reviewed changes
Copy link
Contributor

@shaspitz shaspitz left a comment

Choose a reason for hiding this comment

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

Great work! Very detailed. Just some minor comments

docs/docs/consumer-development/changeover-procedure.md Outdated Show resolved Hide resolved
docs/docs/consumer-development/changeover-procedure.md Outdated Show resolved Hide resolved
docs/docs/consumer-development/changeover-procedure.md Outdated

When the `spawn_time` is reached on the `provider` it will generate a `ConsumerGenesis` that contains the validator set that will supercede the `sovereign` validator set.

This `ConsumerGenesis` must be available on the sovereign chain during the on-chain upgrade.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add in a note about having to manually mutate the JSON to set PreCCV = true:?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catcH!

docs/docs/consumer-development/changeover-procedure.md Outdated Show resolved Hide resolved
docs/docs/introduction/terminology.md Outdated Show resolved Hide resolved
docs/docs/consumer-development/changeover-procedure.md Outdated Show resolved Hide resolved
shaspitz
shaspitz approved these changes Jul 17, 2023
View reviewed changes
Copy link
Contributor

@shaspitz shaspitz left a comment

Choose a reason for hiding this comment

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

Looks great thanks!

docs/docs/introduction/terminology.md Show resolved Hide resolved
mpoke
mpoke approved these changes Jul 18, 2023
View reviewed changes
Copy link
Contributor

@mpoke mpoke left a comment

Choose a reason for hiding this comment

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

Great work @MSalopek

docs/docs/consumer-development/changeover-procedure.md Outdated Show resolved Hide resolved
@MSalopek MSalopek changed the title docs: add changeover procedure part-1 docs: add changeover procedure Jul 18, 2023
@MSalopek MSalopek merged commit b03f6f0 into main Jul 18, 2023
@MSalopek MSalopek deleted the masa/1069-changeover-docs branch July 18, 2023 21:11
insumity pushed a commit that referenced this pull request Jul 24, 2023
@MSalopek
docs: add changeover procedure (#1123)
a4d3c87 
* docs: add changeover procedure part-1

* docs: add changeover procedure part-2 - onboarding checklist

* docs: update terminoloy; add validator instructions stubs

* docs: update validator docs

* docs: update changeover docs and validator guide

* deps: update docusaurus deps

* docs: update changeover docs and validator guide

* docs: update changeover docs and validator guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shaspitz shaspitz shaspitz approved these changes

@mpoke mpoke mpoke approved these changes

Assignees

@MSalopek MSalopek

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create tutorial for standalone to consumer changeover
3 participants
@MSalopek @mpoke @shaspitz