Check broken links in Kubernetes Community repo

check-broken-k8s-links.md

Check broken links in Kubernetes Community repo

To help the community and make sure that all documentation is up to date and correct, a very important role to play is to make sure all links are working correctly.

To do this, you can use simple tools such as markdown-link-check.

Setup

1. Install markdown-link-check.
2. Clone the Kubernetes Community repo:

git clone https://github.com/kubernetes/community
cd community

3. Create a simple configuration file for markdown-link-check within your project root, call it something like `broken-check.json:

{
    "replacementPatterns": [
        {
            "pattern": "^/",
            "replacement": "/your/project/root/"
        }
    ]
}

4. Run markdown-link-check against the files you want to check:

• Single file:

markdown-link-check -c broken-check.json README.md

• Recursive:

find . -name \*.md -exec markdown-link-check -qv -c broken-check.json {} \;