Skip to content
Kubernetes website and documentation repo:
Branch: master
Clone or download
manishbansal8843 and k8s-ci-robot Improved PodPreset documentation (#15409)
* Adding scroller to the command

* Updated

* Updated
Latest commit 8a09d41 Jul 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update the pull Request template wording (#14619) May 30, 2019
archetypes Convert site to Hugo (#8316) May 5, 2018
assets/sass Cycle KubeCon info on landing page (#15170) Jun 27, 2019
content Improved PodPreset documentation (#15409) Jul 21, 2019
data Restructure the left navigation pane of setup (#14826) Jun 12, 2019
functions-src Add header-checking function (#9880) Oct 3, 2018
i18n Add Hindi snippets translation file and missing config.toml params (#… Jun 24, 2019
layouts Fix Prev/Next navigation buttons when viewing article (#15439) Jul 21, 2019
scripts Add readme for scripts (#14913) Jul 8, 2019
static Update contribution guidelines for approvers (#15385) Jul 12, 2019
update-imported-docs Reference documentation for kube components (#13444) Mar 27, 2019
.dockerignore Prevent to send all files to docker daemon (#10129) Aug 30, 2018
.editorconfig Add editorconfig (#11551) Jan 28, 2019
.gitignore Use Hugo extended for Sass/CSS (#13113) Jun 9, 2019
CONTRIBUTING.md Use CoCC email for reporting CoC violations (#10621) Oct 15, 2018
Dockerfile Use Hugo extended for Sass/CSS (#13113) Jun 9, 2019
LICENSE symbol errors Dec 22, 2016
Makefile Syncing release-branch 'test-example' change to master (#15137) Jun 26, 2019
OWNERS Add milestone team, clean up others teams (#13287) Mar 20, 2019
OWNERS_ALIASES update sig-docs-ja-owners and sig-docs-ja-reviewers (#15449) Jul 16, 2019
README-de.md Add german slack channel and maintainer (#14489) Jun 3, 2019
README-es.md Init Spanish translation (#13543) Apr 4, 2019
README-fr.md Init French translation (#12548) Feb 13, 2019
README-hi.md Localise readme.md in hindi (#13910) May 8, 2019
README-id.md Init Indonesian translation (#13822) Apr 16, 2019
README-ja.md add Japanese readme (#15403) Jul 16, 2019
README-ko.md Fix grammar errors on README-ko.md (#14787) Jun 26, 2019
README-pt.md Adjusting main README-pt.md (#15364) Jul 15, 2019
README-zh.md fix: add zh readme (#14773) Jun 20, 2019
README.md add Japanese readme (#15403) Jul 16, 2019
SECURITY_CONTACTS Update embargo doc link in SECURITY_CONTACTS and change PST to PSC (#… Mar 20, 2019
code-of-conduct.md Add the code of conduct (#11919) Feb 4, 2019
config.toml Disable Italian (#15134) Jun 27, 2019
labels.yaml Issue #124: Automatically create labels. Aug 5, 2016
netlify.toml Update to Hugo 0.53 and remove all .Site references (#12079) Feb 5, 2019
package.json Add header-checking function (#9880) Oct 3, 2018

README.md

The Kubernetes documentation

Build Status GitHub release

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

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:

Localization README.md's

French README Korean README
German README Portuguese README
Hindi README Spanish README
Indonesian README Chinese README
Japanese README

Running the website locally using Docker

The recommended way to run the Kubernetes website locally is to run a specialized Docker image that includes the Hugo static website generator.

If you are running on Windows, you'll need a few more tools which you can install with Chocolatey. choco install make

If you'd prefer to run the website locally without Docker, see Running the website locally using Hugo below.

If you have Docker up and running, build the kubernetes-hugo Docker image locally:

make docker-image

Once the image has been built, you can run the website locally:

make docker-serve

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.

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.

To run the website locally when you have Hugo installed:

make serve

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.

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

Code of conduct

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

Thank you!

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

You can’t perform that action at this time.