Fixing Broken Links In PingCAP Documentation

by Admin 45 views
Broken Link Detected in PingCAP Documentation

Hey everyone,

We've run a check on the PingCAP documentation and found some broken links. Here's a breakdown of what we found and what it means.

Summary of Broken Links

Alright, let's dive into the overall status of our link checks. This is super important for keeping our documentation top-notch and user-friendly!

  • 🔍 Total Links Checked: We've checked a whopping 18809 links! That's a ton of links, ensuring we're covering as much ground as possible.
  • ✅ Successful Links: Out of those, 6352 links are working perfectly. Great job to everyone who contributed to those pages!
  • ⏳ Timeouts: Thankfully, we have 0 timeouts. This means our links are generally responding quickly.
  • 🔀 Redirected Links: Zero redirects, which is also great. No need to worry about links leading you in circles.
  • 👻 Excluded Links: A considerable number, 12190, were excluded. These are likely intentional exclusions (links we don't want to check for various reasons).
  • ❓ Unknown Links: Fortunately, 0 links fell into the unknown category. Everything is accounted for!
  • 🚫 Errors: Now, the part we need to address: we found 258 errors. These are the broken links we need to fix to ensure a smooth experience for our users. Let's get these fixed, team!

Detailed Breakdown of Errors

Now, let's zoom in on where exactly these broken links are hiding. Knowing the specific files helps us target our fixes and keep our documentation squeaky clean. Here’s the breakdown:

Errors in information-schema/information-schema-tidb-index-usage.md

  • We found a 404 error here: [https://docs.pingcap.com/tidb/v8.0/tidb-configuration-file#tidb_enable_collect_execution_info](https://docs.pingcap.com/tidb/v8.0/tidb-configuration-file#tidb_enable_collect_execution_info). This link is supposed to point to the tidb_enable_collect_execution_info setting in the TiDB configuration file, but it's currently not found. This is quite important because users rely on this setting for performance tuning and diagnostics. Without a working link, they might struggle to configure their systems optimally. We need to ensure this link directs users to the correct section in the documentation, possibly by updating the link if the section has moved or been renamed.

Errors in releases/release-8.3.0.md

  • Several 404 errors popped up in this file, indicating issues with links related to the v8.3 release. Specifically:

    • [https://docs.pingcap.com/tidb/v8.3/system-variables#tidb_opt_projection_push_down-new-in-v610](https://docs.pingcap.com/tidb/v8.3/system-variables#tidb_opt_projection_push_down-new-in-v610)
    • [https://docs.pingcap.com/tidb/v8.3/statistics#collect-statistics-on-some-columns](https://docs.pingcap.com/tidb/v8.3/statistics#collect-statistics-on-some-columns)
    • [https://docs.pingcap.com/tidb/v8.3/tidb-binlog-overview](https://docs.pingcap.com/tidb/v8.3/tidb-binlog-overview)
    • [https://docs.pingcap.com/tidb/v8.3/partitioned-table#global-indexes](https://docs.pingcap.com/tidb/v8.3/partitioned-table#global-indexes)
    • [https://docs.pingcap.com/tidb/v8.3/quick-start-with-tidb](https://docs.pingcap.com/tidb/v8.3/quick-start-with-tidb)
    • [https://docs.pingcap.com/tidb/v8.3/tiproxy-overview](https://docs.pingcap.com/tidb/v8.3/tiproxy-overview)

    These broken links cover essential topics such as system variables, statistics collection, TiDB Binlog, partitioned tables, quick start guides, and TiProxy. The absence of these links can severely hinder users trying to understand and implement these features in the v8.3 release. We need to investigate whether these sections have been moved, renamed, or removed, and then update or replace the links accordingly. A thorough review is crucial to ensure users have access to this vital information.

Errors in ecosystem-tool-user-guide.md

  • A 429 error (Too Many Requests) was detected for [https://github.com/pingcap/tiup/tree/master/components/cluster](https://github.com/pingcap/tiup/tree/master/components/cluster). This suggests the link is valid but being rate-limited, likely due to excessive requests from our link checker. While the link itself isn't broken, we should monitor this to ensure users can access the TiUP cluster components documentation without issues. Temporarily reducing the frequency of checks for this link might help avoid the rate limiting.

Errors in releases/release-5.4.0.md

  • We found a 404 error for [https://docs.pingcap.com/tidb-data-migration/v5.3/](https://docs.pingcap.com/tidb-data-migration/v5.3/). This link should lead to the TiDB Data Migration (DM) v5.3 documentation, but it's currently unavailable. This is problematic because users rely on DM for seamless data migration. Ensuring this link is active is essential for users looking to migrate their data using this version. We need to verify if the documentation has been moved or if the link needs updating to the correct location.

Errors in releases/release-7.3.0.md

  • Several 404 errors were identified, including:

    • [https://docs.pingcap.com/tidb/v7.3/quick-start-with-tidb](https://docs.pingcap.com/tidb/v7.3/quick-start-with-tidb)
    • [https://docs.pingcap.com/tidb/v7.3/tidb-lightning-physical-import-mode-usage#conflict-detection](https://docs.pingcap.com/tidb/v7.3/tidb-lightning-physical-import-mode-usage#conflict-detection)
    • [https://github.com/haiyux](https://github.com/haiyux)
    • [https://docs.pingcap.com/tidb/v7.3/optimizer-hints](https://docs.pingcap.com/tidb/v7.3/optimizer-hints)
    • [https://docs.pingcap.com/tidb/v7.3/tidb-resource-control#query-watch-parameters](https://docs.pingcap.com/tidb/v7.3/tidb-resource-control#query-watch-parameters)
    • [https://docs.pingcap.com/tidb/v7.3/partitioned-raft-kv](https://docs.pingcap.com/tidb/v7.3/partitioned-raft-kv)
    • [https://docs.pingcap.com/tidb/v7.3/statistics#incremental-collection](https://docs.pingcap.com/tidb/v7.3/statistics#incremental-collection)
    • [https://docs.pingcap.com/tidb/v7.3/sql-statement-show-analyze-status](https://docs.pingcap.com/tidb/v7.3/sql-statement-show-analyze-status)
    • [https://github.com/River2000i](https://github.com/River2000i)

    These missing links are critical, covering quick start guides, TiDB Lightning, optimizer hints, resource control, partitioned Raft KV, statistics, and SQL statements. They prevent users from accessing essential information for the v7.3 release. Immediate action is required to update these links, ensuring users can properly utilize these features. This includes checking for moved content, renamed sections, or updated documentation.

Errors in glossary.md

  • A 429 error was found at [https://github.com/tikv/rfcs/blob/master/text/0082-dynamic-size-region.md#bucket](https://github.com/tikv/rfcs/blob/master/text/0082-dynamic-size-region.md#bucket). As with the previous 429 error, this is likely due to rate limiting from GitHub. We should monitor this link and reduce check frequency if necessary to ensure users can access the dynamic size region RFC without issues.

Errors in grafana-resource-control-dashboard.md

  • A 429 error affects [https://github.com/pingcap/tidb/blob/master/docs/design/2022-11-25-global-resource-control.md#distributed-token-buckets](https://github.com/pingcap/tidb/blob/master/docs/design/2022-11-25-global-resource-control.md#distributed-token-buckets). The