tiproxy: add notice about upgrading tiproxy

[djshow832]

What is changed, added or deleted? (Required)

Users may mistakenly think that upgrading tiproxy won't upgrade the cluster.

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

• master (the latest development version)
• v9.0 (TiDB 9.0 versions)
• v8.5 (TiDB 8.5 versions)
• v8.4 (TiDB 8.4 versions)
• v8.3 (TiDB 8.3 versions)
• v8.1 (TiDB 8.1 versions)
• v7.5 (TiDB 7.5 versions)
• v7.1 (TiDB 7.1 versions)
• v6.5 (TiDB 6.5 versions)
• v6.1 (TiDB 6.1 versions)
• v5.4 (TiDB 5.4 versions)

What is the related PR or file link(s)?

• This PR is translated from: add notice about upgrading tiproxy docs-cn#20568
• Other reference link(s):

Do your changes match any of the following descriptions?

• Delete files
• Change aliases
• Need modification after applied to another branch
• Might cause conflicts after applied to another branch

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign qiancai for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[gemini-code-assist]

Summary of Changes

Hello @djshow832, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request aims to improve the clarity of the TiProxy upgrade documentation. The primary goal is to inform users about the full impact of upgrading TiProxy, specifically that it necessitates a restart of the entire TiDB cluster, which might not be immediately obvious. This change enhances user understanding and helps avoid potential operational surprises.

Highlights

• Documentation Clarity for TiProxy Upgrade: I've added a crucial note to the tiproxy-overview.md documentation. This note clarifies that when users upgrade TiProxy using the tiup cluster upgrade command, the entire TiDB cluster will be restarted, even if the TiDB version itself is not being changed. This addresses a common misconception and helps prevent unexpected service interruptions.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds a note to clarify that upgrading TiProxy also restarts the TiDB cluster. The feedback focuses on improving the wording for better clarity and adherence to the documentation style guide.

[gemini-code-assist]

To improve clarity and adhere to the documentation style guide, use a more direct and active phrasing. ¹²

Style Guide References

Suggested change

	> This command will also upgrade the TiDB cluster. The TiDB cluster will always be restarted even if the TiDB version is not changed.
	> This command also upgrades and restarts the TiDB cluster, even if the cluster version does not change.

Footnotes

1. The style guide recommends using the present tense for describing current behavior. (link) ↩

2. The style guide recommends avoiding passive voice. For example, 'The cluster is started by TiUP' should be 'TiUP starts the cluster'. (link) ↩