kubernetes-sigs/kubespray

CI check for broken Link

Offen

#12.104 geöffnet am 03.04.2025

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (1 zugewiesene Person)HTML (4.419 Forks)batch import
help wantedkind/documentation

Repository-Metriken

Stars
 (10.380 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Untersuche die vorhandenen GitHub Actions Workflows im Repository, füge einen neuen Workflow Schritt mit lychee hinzu, um defekte Links zu prufen, und repariere alle gefundenen defekten Links.
Tech Stack
github actions
Domain
devopsci cd
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitGitHub Actions
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70