pingcap / pingcap/docs

404 broken links

Open
#17,075 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted type/bugfix
Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

Error Report

Please answer the following questions before submitting your issue. Thanks!

  1. What is the URL/path of the document related to this issue?

    See this PR https://github.com/pingcap/docs/pull/17041, which fixed 404 links for one branch. This PR has been cherry-picked to release-8.0 and release-7.5 branches, but 404 links also exist in other branches.

    Notes:

    • Different branches might have different 404 links.
    • Before you create a PR to a corresponding release-x branch, make sure the branch is active. You can check the active versions by clicking the version box on the top left corner of https://docs.pingcap.com/tidb/stable. Only update active branches because updating to inactive branches won't show on the docs.pingcap.com site.
  2. How would you like to improve it?

    It would be better to fix all 404 links for all branches, but this can take a lot of time to check and fix them all. If you get some time and have interest, welcome to help create a PR or PRs to help fix them.


Handling progress:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing PR 17041 to understand how 404 links were found and fixed. Check the version box on docs.pingcap.com/tidb/stable to confirm active branches, then inspect the listed release branches. Done means fixing the broken links for an active branch and marking its progress item complete.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.