kubernetes-sigs/kubespray

CI check for broken Link

Open

#12,104 opened on Apr 3, 2025

View on GitHub
 (2 comments) (0 reactions) (1 assignee)HTML (4,419 forks)batch import
help wantedkind/documentation

Repository metrics

Stars
 (10,380 stars)
PR merge metrics
 (Avg merge 25d) (26 merged PRs in 30d)

Description

What would you like to be added

Automatically check broken links in the CI process by using automated broken link checking tools such as lychee. and fix broken links, like https://github.com/cncf/landscape/blob/master/.github/workflows/linkchecker.yml

Why is this needed

Currently, there are quite a few broken links in the Kubespray documentation. A preliminary scan reveals the following issues.

Image

Automated broken link checking could help resolve this problem.

Contributor guide

Research direction
Examine existing GitHub Actions workflows in the repository, add a new workflow step using lychee to check for broken links, and fix any broken links found.
Tech stack
github actions
Domain
devopsci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70