Skip to content

*: fix 404 links in the v7.1 documentation - #21941

Merged
ti-chi-bot[bot] merged 2 commits into
pingcap:release-7.1from
lilin90:fix/broken-links-release-7.1-23898
Sep 18, 2026
Merged

ti-chi-bot[bot] merged 2 commits into
pingcap:release-7.1from
lilin90:fix/broken-links-release-7.1-23898

Conversation

@lilin90

@lilin90 lilin90 commented Sep 18, 2026

Copy link
Copy Markdown
Member

First-time contributors' checklist

What is changed, added or deleted? (Required)

This PR fixes the 404 links that are still left in the release-7.1 branch, as requested in #17075.

#17041 fixed this kind of link in master and was cherry-picked only to release-8.0 and release-7.5, so release-7.1 still carries them. I checked every external link that this PR touches: the old URLs return 404 and the new ones return 200.

File(s) Before After
develop/dev-guide-sample-application-aws-lambda.md
develop/dev-guide-sample-application-nextjs.md
https://github.com/sidorares/node-mysql2/tree/master/documentation/en https://sidorares.github.io/node-mysql2/docs/documentation
tidb-lightning/tidb-lightning-overview.md
tidb-troubleshooting-map.md
https://github.com/pingcap/tidb/tree/master/br/pkg/lightning https://github.com/pingcap/tidb/tree/release-7.1/br/pkg/lightning
br/br-snapshot-guide.md
faq/backup-and-restore-faq.md
https://github.com/pingcap/tidb/blob/master/br/pkg/restore/systable_restore.go#L31 https://github.com/pingcap/tidb/blob/release-7.1/br/pkg/restore/systable_restore.go#L31
releases/release-7.1.3.md
releases/release-6.5.7.md
https://github.com/AilinKid} https://github.com/AilinKid
releases/release-6.5.7.md https://github.com/zhangjinpeng1987 https://github.com/zhangjinpeng87

Three notes on the approach:

  • The pingcap/tidb source links are pinned to release-7.1 instead of master. br: not support executing backup task and restore task at the same time (#16223) #17041 pointed them to master, but in master these paths have moved again (br/pkg/lightning to lightning, and br/pkg/restore/systable_restore.go to br/pkg/restore/snap_client). Both paths still exist in the release-7.1 branch of pingcap/tidb, release-7.5 already uses this version-pinned form, and it keeps the linked source consistent with the TiDB version that this documentation describes. Please let me know if you would rather follow the master form used in br: not support executing backup task and restore task at the same time (#16223) #17041.
  • The aliases change from br: not support executing backup task and restore task at the same time (#16223) #17041 is not ported. Those aliases cover /tidb/dev/... URLs for develop/dev-guide-sample-application-java-jdbc.md. No document in this branch links to the old path, and the corresponding /tidb/v7.1/... URL never existed, so the aliases are not needed here.
  • Two pre-existing dead links are left untouched. develop/dev-guide-sample-application-aws-lambda.md and develop/dev-guide-sample-application-nextjs.md still link to https://ask.pingcap.com/ and https://support.pingcap.com/, which no longer resolve. They appear in 74 and 79 files across this branch and master has replaced the whole "Need help?" block, so fixing them here would be inconsistent and out of scope. I am happy to file a separate issue or PR for them. Note that this may make the Links (Fail Fast) job report these two files.

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)
  • v7.2 (TiDB 7.2 versions)
  • v7.1 (TiDB 7.1 versions)
  • v7.0 (TiDB 7.0 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)

The fix is version-specific because each branch has to point at its own pingcap/tidb branch, so no cherry-pick label is added. A separate PR covers release-6.5.

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

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

Summary by CodeRabbit

  • Documentation
    • Updated links to system-table references and TiDB Lightning source code to target the 7.1 release branch.
    • Replaced connection pool and prepared statement links with the corresponding Chinese mysql2 documentation pages.
    • Corrected contributor links and usernames in release notes.
    • Fixed a broken contributor URL in the 7.1.3 release notes.

@lilin90 lilin90 added area/develop This PR relates to the area of TiDB App development. ok-to-test Indicates a PR is ready to be tested. translation/from-docs This PR is translated from a PR in pingcap/docs. labels Sep 18, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 18, 2026

Copy link
Copy Markdown

@coderabbitai[bot]: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

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.

@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 18, 2026
@lilin90 lilin90 self-assigned this Sep 18, 2026
Update outdated GitHub links in backup/restore and troubleshooting docs to the release-7.1 branch, and replace node-mysql2 English docs with the Chinese documentation pages. Also correct malformed GitHub author links and a mistaken TiCDC author handle in the 6.5.7 and 7.1.3 release notes so the docs render cleanly and point to the right references.
@ti-chi-bot ti-chi-bot Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 18, 2026
@coderabbitai

coderabbitai Bot commented Sep 18, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 2ec0b4aa-b929-45fe-9c4b-0dfe391b4c62

📥 Commits

Reviewing files that changed from the base of the PR and between 45d8c18 and 39e5f59.

📒 Files selected for processing (7)
  • br/br-snapshot-guide.md
  • develop/dev-guide-sample-application-aws-lambda.md
  • develop/dev-guide-sample-application-nextjs.md
  • faq/backup-and-restore-faq.md
  • releases/release-6.5.7.md
  • releases/release-7.1.3.md
  • tidb-troubleshooting-map.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The pull request updates documentation links to release-specific and Chinese mysql2 documentation pages. It also corrects malformed or incorrect GitHub author links in two release-note files. No product behavior or public declarations change.

Changes

Documentation link corrections

Layer / File(s) Summary
Release-specific source links
br/br-snapshot-guide.md, faq/backup-and-restore-faq.md, tidb-troubleshooting-map.md
Three TiDB source links now target the release-7.1 branch instead of master.
Localized mysql2 links
develop/dev-guide-sample-application-aws-lambda.md, develop/dev-guide-sample-application-nextjs.md
Four mysql2 recommendation links now target the Chinese documentation site.
Release note author links
releases/release-6.5.7.md, releases/release-7.1.3.md
One malformed GitHub URL is fixed, and one incorrect GitHub username is corrected.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 39e5f

The documentation link corrections do not change product behavior and are ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: fixing 404 links in the v7.1 documentation.
Description check ✅ Passed The description covers the required change summary, affected version, related references, AI involvement, and scope checkboxes. It also explains excluded changes and known remaining dead links.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A rabbit checks each link with care
Release branches now point there
Chinese guides shine clear and bright
Author names now read just right
No code hops, no systems sway
Clean paths guide the docs today

Comment @coderabbitai help to get the list of available commands.

@lilin90 lilin90 added the lgtm label Sep 18, 2026
@lilin90

lilin90 commented Sep 18, 2026

Copy link
Copy Markdown
Member Author

/approve

@ti-chi-bot

ti-chi-bot Bot commented Sep 18, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lilin90

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

The pull request process is described here

Details Needs approval from an approver in each of these files:

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

@ti-chi-bot ti-chi-bot Bot added the approved label Sep 18, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit 6b93f69 into pingcap:release-7.1 Sep 18, 2026
7 of 8 checks passed
@lilin90
lilin90 deleted the fix/broken-links-release-7.1-23898 branch September 18, 2026 07:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/develop This PR relates to the area of TiDB App development. lgtm ok-to-test Indicates a PR is ready to be tested. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/from-docs This PR is translated from a PR in pingcap/docs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant