Kubernetes website and documentation repo:
jrnt30 and k8s-ci-robot Update overview.md (#10364)
small change to adjust formatting to properly block notes independently
Latest commit e2e8fb5 Sep 22, 2018
Permalink
Failed to load latest commit information.
.github Reorganize docs contrib guide (#9510) Aug 6, 2018
archetypes Convert site to Hugo (#8316) May 5, 2018
assets/sass Make the home page into reusable and translatable blocks (#10071) Sep 14, 2018
content Update overview.md (#10364) Sep 22, 2018
data remove the left bits of salt (#10248) Sep 21, 2018
i18n Make the home page into reusable and translatable blocks (#10071) Sep 14, 2018
layouts remove duplicate stack overflow icon (#10318) Sep 18, 2018
resources Make the home page into reusable and translatable blocks (#10071) Sep 14, 2018
scripts Add _headers file checking logic (#9879) Aug 21, 2018
static resize screenshot (#10360) Sep 21, 2018
update-imported-docs Rework tool/doc for updating reference docs (#10123) Sep 21, 2018
.dockerignore Prevent to send all files to docker daemon (#10129) Aug 30, 2018
.gitignore Add .editorconfig to .gitignore (#9484) Jul 12, 2018
.travis.yml Improve examples test (#9467) Jul 11, 2018
CONTRIBUTING.md delete redundant space Oct 19, 2017
Dockerfile fix Dockerfile (#10312) Sep 20, 2018
LICENSE symbol errors Dec 22, 2016
Makefile Add _headers file checking logic (#9879) Aug 21, 2018
OWNERS Add tfogo to OWNERS (#10301) Sep 14, 2018
OWNERS_ALIASES Update SIG Azure reviewers (#9796) Aug 13, 2018
README.md New netlify.toml link (#10098) Aug 28, 2018
SECURITY_CONTACTS Add a SECURITY_CONTACTS file (#8824) Jun 6, 2018
config.toml Make the home page into reusable and translatable blocks (#10071) Sep 14, 2018
labels.yaml Issue #124: Automatically create labels. Aug 5, 2016
netlify.toml Add _headers file checking logic (#9879) Aug 21, 2018
skip_title_check.txt Newly generated kubeadm includes. (#7882) Mar 28, 2018
skip_toc_check.txt Newly generated kubeadm includes. (#7882) Mar 28, 2018
verify-docs-format.sh WIP: Cleanup /docs/contribute/ migration (#3278) Apr 10, 2017

README.md

The Kubernetes documentation

Welcome! This repository houses all of the assets required to build the Kubernetes website and documentation. We're very pleased 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 originally 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:

Running the site locally using Hugo

The Kubernetes documentation is built using the Hugo static site generator. See the official Hugo documentation for Hugo installation instructions.

Building and running the site requires the Hugo version specified by the HUGO_VERSION environment variable in the netlify.toml file.

To run the site 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 site. As you make changes to the source files, Hugo updates immediately and forces a browser refresh.

Building the site using Docker

You can build the Kubernetes docs using Docker. To get started, make sure that you have Docker running and build the image locally:

make docker-image

Once the kubernetes-hugo image has been built locally, you can run the site locally:

make docker-serve

Open up your browser to http://localhost:1313 to view the site.

Thank you!

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