Website contributions

Build, preview, and verify links on the Kueue documentation site

The Kueue website (kueue.sigs.k8s.io) is built with Hugo and published through Netlify from the site/ directory.

Local preview

From the repository root:

make site-server

See site/README.md for Hugo version requirements and Netlify parity notes.

Netlify deploy previews

Pull requests that change site/ or netlify.toml receive a Netlify deploy preview. The preview URL follows:

https://deploy-preview-<PR>--kubernetes-sigs-kueue.netlify.app/

Wait for the deploy/netlify GitHub commit status to succeed on your PR head commit before relying on the preview.

Broken documentation links are checked in two ways:

  1. Periodic jobperiodic-kueue-verify-website-links-main crawls the live site daily.
  2. Presubmit jobpull-kueue-verify-website-links-preview-main crawls your PR’s Netlify preview.

For website PRs, after Netlify succeeds, trigger the presubmit on your pull request:

/test pull-kueue-verify-website-links-preview-main

The presubmit is optional and non-blocking while maintainers evaluate reliability. When your PR modifies site/, the job is scheduled automatically but still does not block merge.

Locally:

make verify-website-links

For details on scripts, skip conditions, and environment variables, see hack/testing/linkchecker/README.md.