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: move around upgrade docs #16339

Merged
merged 6 commits into from
May 31, 2023
Merged

docs: move around upgrade docs #16339

merged 6 commits into from
May 31, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented May 30, 2023

Description

Working on #15120 made me look at upgrade docs.
Which explains the workaround described in #15120 fairly extensively, but that is another issue 😅

However, I have noticed a quick improvement could be made to the general SDK upgrade docs, by simply moving the well written extensive x/upgrade/doc.go to display in our documentation.

ref: #11504


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)

@julienrbrt julienrbrt requested a review from a team as a code owner May 30, 2023 15:54
@github-actions github-actions bot added C:Cosmovisor Issues and PR related to Cosmovisor C:x/upgrade labels May 30, 2023
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

thanks for moving this

@julienrbrt julienrbrt enabled auto-merge May 31, 2023 10:32
@julienrbrt julienrbrt added this pull request to the merge queue May 31, 2023
Merged via the queue into main with commit 89b1009 May 31, 2023
@julienrbrt julienrbrt deleted the julien/docs branch May 31, 2023 10:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Cosmovisor Issues and PR related to Cosmovisor C:x/upgrade
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants