docs: Update upgrade docs

[lucaslopezf]

Description

ref: #21429

---

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, you can find examples of the prefixes below:
• confirmed ! in 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
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• New Features

  • Introduced a new CLI command authority for querying the authorized address for upgrade proposals.
  • Added a new REST endpoint /cosmos/upgrade/v1beta1/authority for similar functionality.
  • Included a gRPC query cosmos.upgrade.v1beta1.Query/Authority for accessing upgrade information.

• Improvements

  • Renamed the command for canceling an upgrade proposal to cancel-upgrade-proposal for clarity.
  • Enhanced documentation with clearer instructions and examples across different interfaces.

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The changes in this pull request focus on enhancing the documentation for the x/upgrade module within the README.md file. Key updates include the introduction of a new CLI command and REST endpoint for querying the authorized address for upgrade proposals, along with a new gRPC query. Additionally, the command for canceling an upgrade proposal has been renamed for clarity. These modifications aim to provide clearer instructions and consistent functionality across different interfaces.

Changes

File	Change Summary
x/upgrade/README.md	- Added new CLI command authority for querying authorized address.
	- Introduced new REST endpoint /cosmos/upgrade/v1beta1/authority.
	- Added gRPC query cosmos.upgrade.v1beta1.Query/Authority.
	- Renamed transaction command from cancel-software-upgrade to cancel-upgrade-proposal.

Possibly related PRs

• feat(tools/cosmovisor): Add ShowUpgradeInfoCmd #21932: This PR introduces a new command show-upgrade-info in the Cosmovisor tool, which relates to the enhancements made in the main PR regarding querying upgrade-related information.
• fix(cosmovisor): fix show-upgrade info command #22010: This PR fixes issues with the show-upgrade-info command, which is directly connected to the functionality introduced in the main PR for querying upgrade information.
• docs: tooling #22049: This PR updates the tooling documentation, which includes references to the CLI commands and functionalities introduced in the main PR, ensuring users have the correct information about the new features.
• docs: update authz docs #22062: This PR updates the documentation for the authz module, which may include references to upgrade-related functionalities, aligning with the overall theme of enhancing upgrade-related documentation in the main PR.
• docs: update package list #22063: This PR updates the package list, which may include references to the upgrade module and its functionalities, ensuring that the documentation reflects the latest changes from the main PR.

Suggested reviewers

• akhilkumarpilli
• sontrinh16
• julienrbrt

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[julienrbrt]

we should use a tag (v0.52.0-beta.1) instead of the release branch to prevent it to channge

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

x/upgrade/README.md (2)

318-338: LGTM! New 'authority' CLI command well-documented.

The new 'authority' CLI command is a valuable addition, allowing users to query the address authorized for upgrade proposals. The documentation is clear and includes a helpful example.

Consider adding a brief note about the significance of this authority address to provide more context for users.

---

351-354: Approved: Improved naming for 'cancel-upgrade-proposal' command.

The renaming of 'cancel-software-upgrade' to 'cancel-upgrade-proposal' enhances consistency and clarity in the CLI commands.

For complete consistency, consider renaming 'software-proposal' to 'upgrade-proposal' in the previous example (not shown in this diff).

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2b91f1c and f5e0df3.

📒 Files selected for processing (1)

• x/upgrade/README.md (8 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

x/upgrade/README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🔇 Additional comments (3)

x/upgrade/README.md (3)

492-512: LGTM! New REST endpoint for querying authority address.

The new '/cosmos/upgrade/v1beta1/authority' endpoint is a welcome addition, providing a RESTful way to query the authorized address for upgrade proposals. The documentation is clear and includes a helpful example.

---

554-554: Approved: Simplified gRPC examples for better readability.

The gRPC examples for 'CurrentPlan' and 'ModuleVersions' have been streamlined, improving readability while maintaining functionality. The consistent format across examples is appreciated.

Also applies to: 576-576

---

652-672: LGTM! New gRPC endpoint for querying authority address.

The new 'cosmos.upgrade.v1beta1.Query/Authority' gRPC endpoint is a valuable addition, providing a gRPC method to query the authorized address for upgrade proposals. The documentation is clear and includes a helpful example, maintaining consistency with the CLI and REST implementations.

[julienrbrt]

lgtm!