Skip to content

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

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

ti-chi-bot[bot] merged 5 commits into
pingcap:release-7.1from
sary8:fix/broken-links-release-7.1

Conversation

@sary8

@sary8 sary8 commented Sep 16, 2026

Copy link
Copy Markdown

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. *: fix broken links #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 *: fix broken links #17041.
  • The aliases change from *: fix broken links #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 TiDB references to point to the release-7.1 branch.
    • Updated node-mysql2 links in AWS Lambda, Next.js, and Node.js guides to use the official documentation site.
    • Refreshed TiDB Lightning overview and troubleshooting links for improved accuracy and consistency.
  • Bug Fixes

    • Corrected attribution links and contributor formatting in the 6.5.7 and 7.1.3 release notes.

The mysql2 documentation is no longer kept in the documentation/en
directory of the sidorares/node-mysql2 repository, so the linked URL
returns 404. Point it to the current documentation site instead.

Ref: pingcap#17075
In the master branch of pingcap/tidb, br/pkg/lightning has been moved
to lightning, and br/pkg/restore/systable_restore.go has been moved to
br/pkg/restore/snap_client, so the linked URLs return 404. Pin them to
the release-7.1 branch, which keeps the original paths and matches the
TiDB version that this documentation describes.

Ref: pingcap#17075
A trailing brace was included in the URL of the AilinKid profile, and
the zhangjinpeng1987 account has been renamed to zhangjinpeng87, so
both links return 404. These links have already been corrected in the
master branch by pingcap#17041.

Ref: pingcap#17075
@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. area/develop This PR relates to the area of TiDB App development. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Sep 16, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 16, 2026

Copy link
Copy Markdown

Hi @sary8. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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 missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 16, 2026
@coderabbitai

coderabbitai Bot commented Sep 16, 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: 98770cc1-d3da-4172-a44b-8fadc5203edc

📥 Commits

Reviewing files that changed from the base of the PR and between 6b8693c and 3ff62d5.

📒 Files selected for processing (1)
  • develop/dev-guide-sample-application-nodejs-mysql2.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • develop/dev-guide-sample-application-nodejs-mysql2.md

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


📝 Walkthrough

Walkthrough

The changes update TiDB links to the release-7.1 branch, replace GitHub mysql2 links with hosted documentation links, and correct release-note attribution references.

Changes

Documentation and release-note corrections

Layer / File(s) Summary
Release branch documentation links
br/br-snapshot-guide.md, faq/backup-and-restore-faq.md, tidb-lightning/tidb-lightning-overview.md, tidb-troubleshooting-map.md
TiDB links now reference the release-7.1 branch instead of master.
Official external documentation links
develop/dev-guide-sample-application-aws-lambda.md, develop/dev-guide-sample-application-nextjs.md, develop/dev-guide-sample-application-nodejs-mysql2.md
mysql2 links now point to the hosted documentation site.
Release-note attribution corrections
releases/release-6.5.7.md, releases/release-7.1.3.md
Contributor links, a contributor username, and malformed markdown syntax were corrected.

Priority: ⬇️ Low

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

Change: Bug fix

Suggested reviewers: lilin90

Merge Risk: ⚪ Minimal · up to 3ff62

The documented link and attribution updates have no identified merge-blocking risk.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: fixing 404 links in the TiDB v7.1 documentation.
Description check ✅ Passed The description is complete. It explains the changes, affected version, related issue and PRs, AI involvement, scope decisions, and remaining unrelated 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
🧪 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 hops through links so bright
Release branches point just right
mysql2 docs now bloom online
Contributor marks align in line
Clean notes rest beneath the moon
The guide grows clearer very soon

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

@sary8 sary8 mentioned this pull request Sep 16, 2026
5 tasks
@sary8

sary8 commented Sep 16, 2026

Copy link
Copy Markdown
Author

Closing and reopening to re-trigger the Prevent Deletion workflow, whose run was cancelled by the concurrency group when I opened #23899 a few seconds later. No change to the commits or files.

@sary8 sary8 closed this Sep 16, 2026
@sary8 sary8 reopened this Sep 16, 2026
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Sep 18, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 18, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-09-18 02:28:22.977659491 +0000 UTC m=+344948.915317085: ☑️ agreed by lilin90.

@lilin90 lilin90 self-assigned this Sep 18, 2026
@lilin90

lilin90 commented Sep 18, 2026

Copy link
Copy Markdown
Member

/ok-to-test

@ti-chi-bot ti-chi-bot Bot added ok-to-test Indicates a PR is ready to be tested. and removed needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Sep 18, 2026
@lilin90 lilin90 added the translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. label Sep 18, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Sep 18, 2026
Refresh the node-mysql2 documentation links in the sample application guides to point to the current docs site. This keeps the connection pool and prepared statement references consistent across the AWS Lambda, Next.js, and Node.js sample docs.
@ti-chi-bot ti-chi-bot Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 18, 2026
Replace the node-mysql2 GitHub README link in the Node.js + mysql2 sample app guide with the direct official documentation URL for clearer navigation to driver usage docs.
@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.

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

lilin90 commented Sep 18, 2026

Copy link
Copy Markdown
Member

/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 e35121c into pingcap:release-7.1 Sep 18, 2026
9 of 10 checks passed
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. contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. ok-to-test Indicates a PR is ready to be tested. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants