-
Notifications
You must be signed in to change notification settings - Fork 705
Fix tiproxy links that used zh version of docs (#21868) #21884
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
Fix tiproxy links that used zh version of docs (#21868) #21884
Conversation
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@dveeden This PR has conflicts, I have hold it. |
@ti-chi-bot: ## If you want to know how to resolve it, please read the guide in TiDB Dev Guide. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository. |
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Summary of ChangesHello @ti-chi-bot, I'm Gemini Code Assist1! 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 accuracy and usability of the TiProxy documentation by correcting outdated or incorrectly localized links. Specifically, it updates references to TiProxy deployment methods, ensuring users are directed to the appropriate English-language guides for installation via TiDB Operator and TiUP, thereby streamlining the user experience and preventing confusion. Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request appears to be an automated cherry-pick that has resulted in merge conflicts in two files. My review focuses on resolving these conflicts.
In tiproxy/tiproxy-deployment-topology.md
, I've suggested removing the conflict markers and keeping the new content which adds helpful links.
In tiproxy/tiproxy-overview.md
, I've also suggested removing conflict markers, but in this case, I recommend keeping the original content. The new content seems out of place in its context and partially duplicates information from another file.
Please review the suggestions to ensure the documentation is correct and readable.
<<<<<<< HEAD | ||
======= | ||
For other deployment methods, refer to the following documents: | ||
|
||
- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy) documentation. | ||
- To quickly deploy TiProxy locally using TiUP, see [Deploy TiProxy](/tiup/tiup-playground.md#deploy-tiproxy). | ||
- To deploy TiProxy using TiUP, see [Installation and usage](/tiproxy/tiproxy-overview.md#installation-and-usage). | ||
|
||
>>>>>>> 68a95fe787 (Fix tiproxy links that used zh version of docs (#21868)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It appears there are merge conflict markers in this file. Please resolve them. I've suggested keeping the content from the incoming change, as it seems to be the intended addition.
<<<<<<< HEAD | |
======= | |
For other deployment methods, refer to the following documents: | |
- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy) documentation. | |
- To quickly deploy TiProxy locally using TiUP, see [Deploy TiProxy](/tiup/tiup-playground.md#deploy-tiproxy). | |
- To deploy TiProxy using TiUP, see [Installation and usage](/tiproxy/tiproxy-overview.md#installation-and-usage). | |
>>>>>>> 68a95fe787 (Fix tiproxy links that used zh version of docs (#21868)) | |
For other deployment methods, refer to the following documents: | |
- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy) documentation. | |
- To quickly deploy TiProxy locally using TiUP, see [Deploy TiProxy](/tiup/tiup-playground.md#deploy-tiproxy). | |
- To deploy TiProxy using TiUP, see [Installation and usage](/tiproxy/tiproxy-overview.md#installation-and-usage). | |
<<<<<<< HEAD | ||
Generate a self-signed certificate for the TiDB instance and place the certificate on all TiDB instances to ensure that all TiDB instances have the same certificate. For detailed steps, see [Generate self-signed certificates](/generate-self-signed-certificates.md). | ||
======= | ||
- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy) documentation. | ||
- To quickly deploy TiProxy locally using TiUP, see [Deploy TiProxy](/tiup/tiup-playground.md#deploy-tiproxy). | ||
>>>>>>> 68a95fe787 (Fix tiproxy links that used zh version of docs (#21868)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems there are merge conflict markers in this file. The new content also seems out of place in this context. I've suggested keeping the original content, which seems correct for this section.
<<<<<<< HEAD | |
Generate a self-signed certificate for the TiDB instance and place the certificate on all TiDB instances to ensure that all TiDB instances have the same certificate. For detailed steps, see [Generate self-signed certificates](/generate-self-signed-certificates.md). | |
======= | |
- To deploy TiProxy using TiDB Operator, see the [TiDB Operator](https://docs.pingcap.com/tidb-in-kubernetes/stable/deploy-tiproxy) documentation. | |
- To quickly deploy TiProxy locally using TiUP, see [Deploy TiProxy](/tiup/tiup-playground.md#deploy-tiproxy). | |
>>>>>>> 68a95fe787 (Fix tiproxy links that used zh version of docs (#21868)) | |
Generate a self-signed certificate for the TiDB instance and place the certificate on all TiDB instances to ensure that all TiDB instances have the same certificate. For detailed steps, see [Generate self-signed certificates](/generate-self-signed-certificates.md). |
@ti-chi-bot: The following test failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Close this PR as this v8.1 docs do not have such zh versions of docs. |
This is an automated cherry-pick of #21868
First-time contributors' checklist
What is changed, added or deleted? (Required)
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?