kubernetes / kubernetes/website

Add PR docs validation workflow using GitHub Actions

Open
#55,005 4 comments 1 reaction 0 assignees View on GitHub
kind/feature lifecycle/stale needs-triage
Dominant language
HTML
Stars
5.4k
Forks
15.7k
Avg merge
4d 18h
Merged PRs (30d)
204

Description

## What would you like to be added

Add lightweight validation for documentation changes on pull requests in kubernetes/website.

A good initial scope could include basic checks such as:
- Markdown formatting validation
- Link or HTML validation (where applicable)

The exact implementation (e.g., local tooling, CI integration, or existing workflows) can be determined based on what best fits the project.

## Why is this needed

The repository already contains scheduled validation workflows, but having validation tied to pull requests would help catch issues earlier and improve contributor experience.

There is also existing configuration such as `.htmltest.yml` and `linkcheck-config.toml`, which could potentially be reused or extended.

## Comments

I am okay to help implement this in a way that aligns with current project practices.

Contributor guide

Open the contributing guide

Research direction

Review the existing scheduled validation workflows in kubernetes/website, then inspect .htmltest.yml and linkcheck-config.toml for checks that can be reused. Confirm how documentation pull requests are currently handled and choose an approach consistent with project practices. Done means pull requests with documentation changes run the agreed Markdown and link or HTML validation checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, html, markdown
Domain
ci-cd, documentation, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.