Skip to content
Kubernetes website and documentation repo:
Branch: master
Clone or download
femrtnz Merge pull request #13945 from vanou/fixingSyntaxErrorInPortugueseReadme
Fix syntax error of Markdown & link error in README-pt.md
Latest commit 81f251b Apr 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
archetypes Convert site to Hugo (#8316) May 5, 2018
content fix(pick-right-solution.md): Remove conflicts and correct possible Gr… Apr 22, 2019
data Official 1.14 Release Docs (#13174) Mar 25, 2019
functions-src Add header-checking function (#9880) Oct 3, 2018
i18n Translation of layout strings (#13841) Apr 18, 2019
layouts Add localization support for layouts (#13832) Apr 17, 2019
sass
scripts Remove Travis CI dependency (#13598) Apr 11, 2019
static blog: remove bobsky from OWNERS (#13561) Apr 19, 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 Add editorconfig (#11551) Jan 28, 2019
CONTRIBUTING.md Use CoCC email for reporting CoC violations (#10621) Oct 15, 2018
Dockerfile Fix ##12434 - Empty continuation line warning while building docker i… Feb 1, 2019
LICENSE symbol errors Dec 22, 2016
Makefile Remove Travis CI dependency (#13598) Apr 11, 2019
OWNERS Add milestone team, clean up others teams (#13287) Mar 20, 2019
OWNERS_ALIASES Fixing one word typo in OWNERS_ALIASES (#13931) Apr 21, 2019
README-de.md [DOCS-DE] Fix DE readme links (#13644) Apr 17, 2019
README-es.md Init Spanish translation (#13543) Apr 4, 2019
README-fr.md Init French translation (#12548) Feb 13, 2019
README-id.md
README-ko.md Add the Localization Korean page's link (#12878) Apr 11, 2019
README-pt.md
README.md Update website link in Readme and badges to readme (Korean) for consi… Feb 28, 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 Fixing conflict (#13773) Apr 16, 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 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:

README.md's Localizing Kubernetes Documentation

Korean

See translation of README.md and more detail guidance for Korean contributors on the Korean README page.

You can reach the maintainers of Korean localization at:

Running the site locally using Docker

The recommended way to run the Kubernetes website locally is to run a specialized Docker image that includes the Hugo static site 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 site 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 site locally:

make docker-serve

Open up your browser to http://localhost:1313 to view the site. As you make changes to the source files, Hugo updates the site and forces a browser refresh.

Running the site locally using Hugo

See the official Hugo documentation for Hugo installation instructions. Make sure to install 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 the site 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 really appreciate your contributions to our site and our documentation!

You can’t perform that action at this time.