Skip to content

Update link checker config and fix some broken links#22601

Merged
ti-chi-bot[bot] merged 3 commits intopingcap:masterfrom
dveeden:broken_links_202603
Mar 20, 2026
Merged

Update link checker config and fix some broken links#22601
ti-chi-bot[bot] merged 3 commits intopingcap:masterfrom
dveeden:broken_links_202603

Conversation

@dveeden
Copy link
Contributor

@dveeden dveeden commented Mar 20, 2026

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

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

  • This PR is translated from:
  • Other reference link(s):

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

@gemini-code-assist
Copy link
Contributor

Note

Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported.

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 20, 2026
@dveeden dveeden force-pushed the broken_links_202603 branch from 2abb2ff to a2b787e Compare March 20, 2026 08:07
@dveeden dveeden requested review from Oreoxmt, hfxsd and qiancai March 20, 2026 08:08
@dveeden dveeden changed the title Update link checker config Update link checker config and fix some broken links Mar 20, 2026
@dveeden
Copy link
Contributor Author

dveeden commented Mar 20, 2026

This doesn't fix all issues

dvaneeden@dve-carbon:~/dev/pingcap/docs$ lychee --cache --max-cache-age 1d --root-dir . --exclude https://docs.pingcap.com/tidb/  --exclude https://docs.pingcap.com/tidb-data-migration/ --exclude vx.y --exclude tidb-operator-version  --exclude github-id --exclude-path './releases/' --exclude-path '^tidb-cloud/releases/' . | grep -E '\[404\]'
17476/17476 ━━━━━━━━━━━━━━━━━━━━ Finished extracting links                                                                                                                                                                                              [404] https://docs.pingcap.com/tidbcloud/secure-connections-to-starter-clusters/ | Error (cached)
[404] https://docs.pingcap.com/tidb-in-kubernetes/stable/restore-from-aws-s3-by-snapshot | Error (cached)
[404] https://docs.airbyte.com/operator-guides/transformation-and-normalization/transformations-with-dbt | Error (cached)
[404] https://docs.pingcap.com/developer/vector-search-full-text-search-python | Error (cached)
[404] https://docs.pingcap.com/developer/vector-search-full-text-search-sql | Error (cached)

@dveeden
Copy link
Contributor Author

dveeden commented Mar 20, 2026

https://github.com/pingcap/docs/actions/workflows/link.yaml shows many failures.

I guess nobody looks at this and the issue generation isn't working?

@dveeden
Copy link
Contributor Author

dveeden commented Mar 20, 2026

image

@dveeden
Copy link
Contributor Author

dveeden commented Mar 20, 2026

Updating the create-issue-from-file action should fix this as since v5.0.1 it should truncate the input if it is too long.

@hfxsd hfxsd added translation/no-need No need to translate this PR. translation/doing This PR's assignee is translating this PR. and removed missing-translation-status This PR does not have translation status info. translation/no-need No need to translate this PR. labels Mar 20, 2026
github-actions bot added a commit to hfxsd/docs-cn that referenced this pull request Mar 20, 2026
Synced from: pingcap/docs#22601
Target PR: pingcap#21453
AI Provider: gemini

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@hfxsd hfxsd added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Mar 20, 2026
Copy link
Collaborator

@qiancai qiancai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found two workflow regressions that are worth fixing before merge:

  1. The scheduled link.yaml job now fails in the lychee step before Create Issue From File can run, so broken links will no longer open the issue this workflow is designed to create.
  2. The same workflow now excludes releases/ and tidb-cloud/releases/ entirely, which removes periodic broken-link coverage from a large set of public release-note pages.

I also spot-checked the updated external documentation URLs in the Markdown files, and the new targets themselves resolve correctly.

Copy link
Collaborator

@qiancai qiancai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rest LGTM

@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Mar 20, 2026
@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Mar 20, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 20, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-03-20 09:44:24.190316958 +0000 UTC m=+522991.277974485: ✖️🔁 reset by qiancai.
  • 2026-03-20 09:47:00.724173436 +0000 UTC m=+523147.811830973: ☑️ agreed by qiancai.
  • 2026-03-20 10:54:34.536150394 +0000 UTC m=+527201.623807931: ☑️ agreed by hfxsd.

@hfxsd
Copy link
Collaborator

hfxsd commented Mar 20, 2026

/approve

@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 20, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hfxsd

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 Mar 20, 2026
@ti-chi-bot ti-chi-bot bot merged commit 09bcd4e into pingcap:master Mar 20, 2026
12 checks passed
@dveeden dveeden mentioned this pull request Mar 20, 2026
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm 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.

3 participants