Skip to content

*: fix 404 links in the v6.5 documentation - #23899

Open
sary8 wants to merge 3 commits into
pingcap:release-6.5from
sary8:fix/broken-links-release-6.5
Open

sary8 wants to merge 3 commits into
pingcap:release-6.5from
sary8:fix/broken-links-release-6.5

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-6.5 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-6.5 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-6.5/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-6.5/br/pkg/restore/systable_restore.go#L31
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-6.5 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-6.5 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/v6.5/... 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)
  • v6.5 (TiDB 6.5 versions)
  • v6.4 (TiDB 6.4 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-7.1.

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 references to TiDB Lightning and MySQL system-table resources to point to the appropriate source branches.
    • Replaced node-mysql2 repository links with the published documentation site.
    • Corrected contributor handles and formatting typos in TiDB 6.5.7 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-6.5 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. labels Sep 16, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 16, 2026

Copy link
Copy Markdown

[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 liuxiaozhen12 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.

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 needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. area/develop This PR relates to the area of TiDB App development. 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: 3db31bfd-768f-4bdc-991c-589a687a7b9a

📥 Commits

Reviewing files that changed from the base of the PR and between 769f326 and 18ad99b.

📒 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
  • tidb-lightning/tidb-lightning-overview.md
  • tidb-troubleshooting-map.md

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


📝 Walkthrough

Walkthrough

Documentation-only edits correct repository branches, replace source-tree links with published mysql2 documentation links, and fix two contributor handles in the TiDB 6.5.7 release notes.

Changes

Documentation Corrections

Layer / File(s) Summary
Version-aligned repository links
br/br-snapshot-guide.md, faq/backup-and-restore-faq.md, tidb-lightning/tidb-lightning-overview.md, tidb-troubleshooting-map.md
Updated TiDB source links to reference the intended master or release-6.5 branch.
Published driver documentation links
develop/dev-guide-sample-application-aws-lambda.md, develop/dev-guide-sample-application-nextjs.md
Replaced the mysql2 GitHub documentation path with the published documentation site URL.
Release-note handle corrections
releases/release-6.5.7.md
Corrected two contributor handles in the TiDB 6.5.7 release notes.

Priority: ⬇️ Low

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

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 18ad9

The documentation and contributor-link corrections introduce no established current-head issue, so the PR is mergeable.

🚥 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 v6.5 documentation. It is concise and relevant.
Description check ✅ Passed The description is complete. It explains the changes, affected version, reference issues, link replacements, scope decisions, AI involvement, and branch-specific considerations.
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 PR with unit tests

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
Correct branches now point somewhere
Published docs greet readers bright
Two handles wear their spelling right
The release notes rest neat tonight

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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. missing-translation-status This PR does not have translation status info. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant