The Kubernetes documentation

This repository contains the assets required to build the Kubernetes website and documentation. We're glad that you want to contribute!

Running the website locally using Hugo

See the official Hugo documentation for Hugo installation instructions. Make sure to install the Hugo extended version specified by the HUGO_VERSION environment variable in the netlify.toml file.

Before building the site, clone the Kubernetes website repository:

git clone https://github.com/kubernetes/website.git
cd website
git submodule update --init --recursive --depth 1

Note: The Kubernetes website deploys the Docsy Hugo theme. If you have not updated your website repository, the website/themes/docsy directory is empty. The site cannot build without a local copy of the theme.

Update the website theme:

git submodule update --init --recursive --depth 1

To build and test the site locally, run:

hugo server --buildFuture

This will start the local Hugo server on port 1313. Open up your browser to http://localhost:1313 to view the website. As you make changes to the source files, Hugo updates the website and forces a browser refresh.

Get involved with SIG Docs

Learn more about SIG Docs Kubernetes community and meetings on the community page.

You can also reach the maintainers of this project at:

• Slack
• Mailing List

Contributing to the docs

You can click the Fork button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a fork. Make any changes you want in your fork, and when you are ready to send those changes to us, go to your fork and create a new pull request to let us know about it.

Once your pull request is created, a Kubernetes reviewer will take responsibility for providing clear, actionable feedback. As the owner of the pull request, it is your responsibility to modify your pull request to address the feedback that has been provided to you by the Kubernetes reviewer.

Also, note that you may end up having more than one Kubernetes reviewer provide you feedback or you may end up getting feedback from a Kubernetes reviewer that is different than the one initially assigned to provide you feedback.

Furthermore, in some cases, one of your reviewers might ask for a technical review from a Kubernetes tech reviewer when needed. Reviewers will do their best to provide feedback in a timely fashion but response time can vary based on circumstances.

For more information about contributing to the Kubernetes documentation, see:

• Contribute to Kubernetes docs
• Page Content Types
• Documentation Style Guide
• Localizing Kubernetes Documentation

Localization README.md's

Language	Language
Chinese	Korean
French	Polish
German	Portuguese
Hindi	Russian
Indonesian	Spanish
Italian	Ukrainian
Japanese	Vietnamese

Code of conduct

Participation in the Kubernetes community is governed by the CNCF Code of Conduct.

Thank you!

Kubernetes thrives on community participation, and we appreciate your contributions to our website and our documentation!