-
Notifications
You must be signed in to change notification settings - Fork 709
v6.5-v8.1: update download URL from pingcap.org to pingcap.com #22241
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
base: release-7.5
Are you sure you want to change the base?
Conversation
|
[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. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Summary of ChangesHello @Oreoxmt, 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 focuses on a critical maintenance task: updating all download URLs within the TiDB documentation. The change involves migrating links from the older Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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 correctly updates download URLs from pingcap.org to pingcap.com across various documentation files. The changes are consistent and necessary. I've also identified a few minor inconsistencies and technical inaccuracies in some of the command examples within the updated files. My suggestions aim to improve the clarity and correctness of the documentation for a better user experience.
|
|
||
| ```bash | ||
| wget https://download.pingcap.org/tidb-community-server-v{{{ .tidb-version }}}-linux-amd64.tar.gz | ||
| wget https://download.pingcap.com/tidb-community-server-v{{{ .tidb-version }}}-linux-amd64.tar.gz |
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.
There's an inconsistency between the downloaded filename and the one used for extraction. The wget command here downloads a version-specific file, but the tar command on the next line attempts to extract tidb-latest-linux-amd64.tar.gz. To ensure the commands work as expected, it's best to download the latest version directly.
| wget https://download.pingcap.com/tidb-community-server-v{{{ .tidb-version }}}-linux-amd64.tar.gz | |
| wget https://download.pingcap.com/tidb-latest-linux-amd64.tar.gz |
|
|
||
| ``` | ||
| [kolbe@localhost ~]$ curl -LO https://download.pingcap.org/tidb-latest-linux-amd64.tar.gz | tar xzf - | ||
| [kolbe@localhost ~]$ curl -LO https://download.pingcap.com/tidb-latest-linux-amd64.tar.gz | tar xzf - |
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.
The command curl -LO ... | tar xzf - in the example output is incorrect. The -O flag saves the output to a file instead of stdout, so the pipe to tar will not work. To match the command's intent of downloading and extracting in one go, it should pipe the output of curl -L.
| [kolbe@localhost ~]$ curl -LO https://download.pingcap.com/tidb-latest-linux-amd64.tar.gz | tar xzf - | |
| [kolbe@localhost ~]$ curl -L https://download.pingcap.com/tidb-latest-linux-amd64.tar.gz | tar xzf - |
| > **Tip:** | ||
| > | ||
| > `{version}` in the link indicates the version number of TiDB and `{arch}` indicates the architecture of the system, which can be `amd64` or `arm64`. For example, the download link for `v{{{ .tidb-version }}}` in the `amd64` architecture is `https://download.pingcap.org/tidb-community-toolkit-v{{{ .tidb-version }}}-linux-amd64.tar.gz`. | ||
| > `{version}` in the link indicates the version number of TiDB and `{arch}` indicates the architecture of the system, which can be `amd64` or `arm64`. For example, the download link for `v{{{ .tidb-version }}}` in the `amd64` architecture is `https://download.pingcap.com/tidb-community-toolkit-v{{{ .tidb-version }}}-linux-amd64.tar.gz`. |
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.
The example download link refers to tidb-community-toolkit, but the context of this section is about downloading the tidb-community-server package. To avoid confusion, the example should be updated to reflect the correct package.
| > `{version}` in the link indicates the version number of TiDB and `{arch}` indicates the architecture of the system, which can be `amd64` or `arm64`. For example, the download link for `v{{{ .tidb-version }}}` in the `amd64` architecture is `https://download.pingcap.com/tidb-community-toolkit-v{{{ .tidb-version }}}-linux-amd64.tar.gz`. | |
| > `{version}` in the link indicates the version number of TiDB and `{arch}` indicates the architecture of the system, which can be `amd64` or `arm64`. For example, the download link for `v{{{ .tidb-version }}}` in the `amd64` architecture is `https://download.pingcap.com/tidb-community-server-v{{{ .tidb-version }}}-linux-amd64.tar.gz`. |
| > **Tip:** | ||
| > | ||
| > `{version}` in the link indicates the version number of TiDB and `{arch}` indicates the architecture of the system, which can be `amd64` or `arm64`. For example, the download link for `v{{{ .tidb-version }}}` in the `amd64` architecture is `https://download.pingcap.org/tidb-community-toolkit-v{{{ .tidb-version }}}-linux-amd64.tar.gz`. | ||
| > `{version}` in the link indicates the version number of TiDB and `{arch}` indicates the architecture of the system, which can be `amd64` or `arm64`. For example, the download link for `v{{{ .tidb-version }}}` in the `amd64` architecture is `https://download.pingcap.com/tidb-community-toolkit-v{{{ .tidb-version }}}-linux-amd64.tar.gz`. |
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.
Similar to a previous comment, the example download link here refers to tidb-community-toolkit, while the context is about downloading the tidb-community-server package. For consistency and accuracy, the example should point to the server package.
| > `{version}` in the link indicates the version number of TiDB and `{arch}` indicates the architecture of the system, which can be `amd64` or `arm64`. For example, the download link for `v{{{ .tidb-version }}}` in the `amd64` architecture is `https://download.pingcap.com/tidb-community-toolkit-v{{{ .tidb-version }}}-linux-amd64.tar.gz`. | |
| > `{version}` in the link indicates the version number of TiDB and `{arch}` indicates the architecture of the system, which can be `amd64` or `arm64`. For example, the download link for `v{{{ .tidb-version }}}` in the `amd64` architecture is `https://download.pingcap.com/tidb-community-server-v{{{ .tidb-version }}}-linux-amd64.tar.gz`. |
|
|
||
| ```bash | ||
| curl -L https://download.pingcap.org/tidb-community-server-v{{{ .tidb-version }}}-linux-amd64.tar.gz | tar xzf - | ||
| curl -L https://download.pingcap.com/tidb-community-server-v{{{ .tidb-version }}}-linux-amd64.tar.gz | tar xzf - |
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.
To improve clarity and consistency with the example output that follows (line 52), consider using the tidb-latest-linux-amd64.tar.gz package directly. This also aligns with the cd tidb-latest-linux-amd64 command on the next line.
| curl -L https://download.pingcap.com/tidb-community-server-v{{{ .tidb-version }}}-linux-amd64.tar.gz | tar xzf - | |
| curl -L https://download.pingcap.com/tidb-latest-linux-amd64.tar.gz | tar xzf - |
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 (in Chinese).
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?