website

This repository holds all the files needed to build and maintain the official Kubernetes documentation website, which lives at kubernetes.io. It is not the Kubernetes software itself, but rather the place where all of the guides, tutorials, and reference pages are written and stored.

Contributors work with this repository to add or update documentation pages, fix errors, and translate content into other languages. The site supports more than a dozen languages, including Chinese, French, German, Japanese, Korean, Spanish, and others, each managed through its own subfolder.

To preview the site on your own computer, you run it locally using a tool called Hugo, which is a static site builder. You can also use a container tool like Docker to run a pre-configured version that matches the live site more closely. Either way, you end up with a local copy of the website you can browse in a browser while making edits.

The reference documentation pages, which describe the Kubernetes programming interface in detail, are generated automatically from a specification file rather than written by hand. There is a process for updating those pages whenever a new version of Kubernetes is released.

If you want to contribute, the usual approach is to fork the repository on GitHub, make your changes, and open a pull request. Reviewers from the documentation team will then give feedback before anything goes live. There are also dedicated new-contributor ambassadors on Slack who help first-time contributors get started.