Kubernetes website and documentation repo:
HTML CSS JavaScript Go Python Shell
Clone or download
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 updated cncf logo and KubeCon china dates (#9782) Aug 8, 2018
content apply template (#9850) Aug 14, 2018
data Localization instructions (#9192) Jul 28, 2018
layouts Improve the preview card when sharing to social media (#9495) Aug 13, 2018
resources/_gen/assets/sass/sass Update to Hugo 0.46 (#9703) Aug 2, 2018
static updated cncf logo and KubeCon china dates (#9782) Aug 8, 2018
update-imported-docs Add release notes for 1.11 (#9287) Jun 28, 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 Update README and Dockerfile (#9781) Aug 8, 2018
LICENSE symbol errors Dec 22, 2016
Makefile Change stage target to docker-serve in Makefile (#9216) Jul 27, 2018
OWNERS Adds ryanmcginnis to OWNERS (#9513) Jul 13, 2018
OWNERS_ALIASES Update SIG Azure reviewers (#9796) Aug 13, 2018
README.md changed the link path to current path. (#9803) Aug 12, 2018
SECURITY_CONTACTS Add a SECURITY_CONTACTS file (#8824) Jun 6, 2018
config.toml config: Get mediaTypes config in line with the Hugo version (#9704) Aug 1, 2018
labels.yaml Issue #124: Automatically create labels. Aug 5, 2016
netlify.toml Add comments to noindex mechanism (#9768) Aug 9, 2018
netlify_noindex_headers.txt Revert 9225, fix indexing for k8s.io (#9767) Aug 6, 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

Instructions for Contributing to the Kubernetes Documentation

Welcome! We are very pleased you want to contribute to the Kubernetes documentation.

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 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:

Building the site using Docker

If you'd like, you can build the Kubernetes docs using Docker. To get started, build the image locally:

make docker-image

# The underlying command:
docker build . \
  --tag kubernetes-hugo \
  --build-arg HUGO_VERSION=0.40.3

You can create an image for a different version of Hugo by changing the value of the HUGO_VERSION argument for the build. You must specify a version or the image will not build. Once the kubernetes-hugo image has been built locally, you can build the site:

make docker-serve

# The underlying command:
docker run \
  --rm \
  --interactive \
  --tty \
  --volume $(PWD):/src \
  -p 1313:1313 \
  kubernetes-hugo \
  hugo server \
  --watch \
  --bind 0.0.0.0

As when building without using a Docker container, the results of the build will be published to the public directory (the default output directory for Hugo, the static site generator used to build this site).

Thank you!

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