Skip to content
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

CI: Update LinkChecker URL excludes #20287

Merged
merged 9 commits into from
Feb 19, 2025

Conversation

dveeden
Copy link
Contributor

@dveeden dveeden commented Feb 13, 2025

What is changed, added or deleted? (Required)

The aim is to reduce false positive in the link checker

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.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 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

@dveeden dveeden requested review from hfxsd, Oreoxmt and qiancai February 13, 2025 10:36
@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 Feb 13, 2025
@dveeden
Copy link
Contributor Author

dveeden commented Feb 13, 2025

With this:

dvaneeden@dve-carbon:~/dev/pingcap/docs$ lychee -V
lychee 0.18.1
dvaneeden@dve-carbon:~/dev/pingcap/docs$ lychee --root-dir $(pwd) .
  29893/29893 ━━━━━━━━━━━━━━━━━━━━ Finished extracting links                                                                                              Issues found in 8 inputs. Find details below.

[./resources/doc-templates/patch_release_note_template_zh.md]:
     [404] https://docs.pingcap.com/zh/tidb/vx.y/quick-start-with-tidb | Network error: Not Found
     [404] https://docs.pingcap.com/zh/tidb/vx.y/production-deployment-using-tiup | Network error: Not Found

[./tidb-cloud/integrate-tidbcloud-with-airbyte.md]:
     [404] https://docs.airbyte.com/operator-guides/transformation-and-normalization/transformations-with-dbt | Network error: Not Found

[./tidb-cloud/release-notes-2023.md]:
     [403] https://docs.pingcap.com/tidbcloud/api/v1beta1#tag/Billing | Network error: Forbidden

[./vector-search/vector-search-integration-overview.md]:
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/vector-search-integrate-with-django-orm | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/vector-search-integrate-with-sqlalchemy | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/vector-search-get-started-using-python | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/vector-search-integrate-with-peewee | Cannot find file

[./develop/dev-guide-overview.md]:
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidbcloud/integrate-tidbcloud-with-airbyte | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidbcloud/get-started-with-cli | Cannot find file

[./support.md]:
 [TIMEOUT] https://internals.tidb.io/ | Timeout

[./develop/dev-guide-third-party-support.md]:
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-sample-application-java-hibernate | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-sample-application-python-sqlalchemy | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-sample-application-golang-gorm | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-sample-application-ruby-rails | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-sample-application-java-jdbc | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-choose-driver-or-orm#tidb-loadbalance | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-choose-driver-or-orm#java-drivers | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-sample-application-java-spring-boot | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-sample-application-java-mybatis | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-sample-application-python-django | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-sample-application-nodejs-sequelize | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-sample-application-nodejs-prisma | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-sample-application-golang-sql-driver | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/dev-guide-sample-application-nodejs-typeorm | Cannot find file

[./_docHome.md]:
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/stable/production-deployment-using-tiup | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidbcloud/tidb-cloud-intro | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidbcloud/tidb-cloud-roadmap | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/stable/quick-start-with-tidb | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidbcloud/vector-search-overview | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidbcloud/dev-guide-overview | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/dev/tidb-roadmap | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/stable/dev-guide-overview | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidbcloud/tidb-cloud-quickstart | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/stable/overview | Cannot find file
   [ERROR] file:///home/dvaneeden/dev/pingcap/docs/tidb/stable/mysql-compatibility | Cannot find file

🔍 29893 Total (in 58s) ✅ 15022 OK 🚫 35 Errors 👻 14826 Excluded ⏳ 1 Timeouts

The above is with the blanked exclude for github.com in place.

Questions etc:

  • For github.com lychee allows you to set a API key to get around the rate limiting. Maybe we should do that? Now a lot of user profiles and other things are resulting in errors. If we don't maybe we should exclude github altogether?
  • What's the status of https://internals.tidb.io/ ? It now gives a timeout.
  • The DocHomeCard things to cause false positives in _docHome.md, but I don't know how to fix them.

@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 Feb 13, 2025
@ti-chi-bot ti-chi-bot bot added the area/develop This PR relates to the area of TiDB App development. label Feb 13, 2025
@ti-chi-bot ti-chi-bot bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 13, 2025
@dveeden
Copy link
Contributor Author

dveeden commented Feb 13, 2025

I've replaced some HTML tables with markdown tables. And same for HTML <a> links and markdown links. This seems to have found at least one incorrect anchor.

@dveeden
Copy link
Contributor Author

dveeden commented Feb 13, 2025

[./tidb-cloud/integrate-tidbcloud-with-airbyte.md]:
     [404] https://docs.airbyte.com/operator-guides/transformation-and-normalization/transformations-with-dbt | Network error: Not Found

This is not a false positive, it really is a broken link, but I don't know what it should be corrected to.

@qiancai qiancai self-assigned this Feb 14, 2025
@qiancai qiancai added the translation/doing This PR's assignee is translating this PR. label Feb 14, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Feb 14, 2025
@qiancai
Copy link
Collaborator

qiancai commented Feb 14, 2025

In link-fail-fast.yaml, the GitHub API token is already used for the link validation requests.

https://github.com/pingcap/docs/blob/master/.github/workflows/link-fail-fast.yaml#L31

@qiancai
Copy link
Collaborator

qiancai commented Feb 14, 2025

internals.tidb.io is now inaccessible. The alternative option is github.com/orgs/pingcap/discussions according to @wuhuizuo. I've created #20294 to update the link.

@dveeden dveeden mentioned this pull request Feb 14, 2025
@dveeden
Copy link
Contributor Author

dveeden commented Feb 14, 2025

Once everything is completed this should help to monitor it: https://github.com/pingcap/docs/blob/master/.github/workflows/link.yaml

@qiancai qiancai requested a review from Icemap February 14, 2025 07:58
@ti-chi-bot ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Feb 14, 2025
@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 Feb 18, 2025
@ti-chi-bot ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Feb 18, 2025
Copy link

ti-chi-bot bot commented Feb 18, 2025

[LGTM Timeline notifier]

Timeline:

  • 2025-02-14 09:59:50.573710056 +0000 UTC m=+609832.969932118: ☑️ agreed by qiancai.
  • 2025-02-18 09:17:21.920422405 +0000 UTC m=+952884.316644467: ☑️ agreed by hfxsd.

dveeden and others added 2 commits February 18, 2025 10:22
@qiancai
Copy link
Collaborator

qiancai commented Feb 19, 2025

/approve

Copy link

ti-chi-bot bot commented Feb 19, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

The pull request process is described here

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 Feb 19, 2025
@ti-chi-bot ti-chi-bot bot merged commit 01c9833 into pingcap:master Feb 19, 2025
9 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. lgtm size/L Denotes a PR that changes 100-499 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