|
1 | 1 | # The Kubernetes documentation |
2 | 2 |
|
3 | | -[](https://travis-ci.org/kubernetes/website) |
4 | | -[](https://github.com/kubernetes/website/releases/latest) |
| 3 | +[](https://app.netlify.com/sites/kubernetes-io-master-staging/deploys) [](https://github.com/kubernetes/website/releases/latest) |
5 | 4 |
|
6 | | -Welcome! This repository houses all of the assets required to build the [Kubernetes website and documentation](https://kubernetes.io/). We're glad that you want to contribute! |
| 5 | +This repository contains the assets required to build the [Kubernetes website and documentation](https://kubernetes.io/). We're glad that you want to contribute! |
7 | 6 |
|
8 | | -## Contributing to the docs |
9 | | - |
10 | | -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. |
11 | | - |
12 | | -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](https://github.com/kubernetes/website/wiki/Tech-reviewers) when needed. Reviewers will do their best to provide feedback in a timely fashion but response time can vary based on circumstances. |
13 | | - |
14 | | -For more information about contributing to the Kubernetes documentation, see: |
15 | | - |
16 | | -* [Start contributing](https://kubernetes.io/docs/contribute/start/) |
17 | | -* [Staging Your Documentation Changes](http://kubernetes.io/docs/contribute/intermediate#view-your-changes-locally) |
18 | | -* [Using Page Templates](http://kubernetes.io/docs/contribute/style/page-templates/) |
19 | | -* [Documentation Style Guide](http://kubernetes.io/docs/contribute/style/style-guide/) |
20 | | -* [Localizing Kubernetes Documentation](https://kubernetes.io/docs/contribute/localization/) |
21 | | - |
22 | | -## Localization `README.md`'s |
23 | | -| | | |
24 | | -|---|---| |
25 | | -|[French README](README-fr.md)|[Korean README](README-ko.md)| |
26 | | -|[German README](README-de.md)|[Portuguese README](README-pt.md)| |
27 | | -|[Hindi README](README-hi.md)|[Spanish README](README-es.md)| |
28 | | -|[Indonesian README](README-id.md)|[Chinese README](README-zh.md)| |
29 | | -|[Japanese README](README-ja.md)|[Vietnamese README](README-vi.md)| |
30 | | -|[Russian README](README-ru.md)|[Italian README](README-it.md)| |
31 | | -|[Polish README](README-pl.md)|[Ukrainian README](README-uk.md)| |
32 | | -||| |
33 | | - |
34 | | -## Running the website locally using Docker |
35 | | - |
36 | | -The recommended way to run the Kubernetes website locally is to run a specialized [Docker](https://docker.com) image that includes the [Hugo](https://gohugo.io) static website generator. |
37 | | - |
38 | | -> If you are running on Windows, you'll need a few more tools which you can install with [Chocolatey](https://chocolatey.org). `choco install make` |
| 7 | +## Running the website locally using Hugo |
39 | 8 |
|
40 | | -> If you'd prefer to run the website locally without Docker, see [Running the website locally using Hugo](#running-the-website-locally-using-hugo) below. |
| 9 | +See the [official Hugo documentation](https://gohugo.io/getting-started/installing/) for Hugo installation instructions. Make sure to install the Hugo extended version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L10) file. |
41 | 10 |
|
42 | | -If you have Docker [up and running](https://www.docker.com/get-started), build the `kubernetes-hugo` Docker image locally: |
| 11 | +To run the website locally when you have Hugo installed: |
43 | 12 |
|
44 | 13 | ```bash |
45 | | -make docker-image |
| 14 | +git clone https://github.com/kubernetes/website.git |
| 15 | +cd website |
| 16 | +hugo server --buildFuture |
46 | 17 | ``` |
47 | 18 |
|
48 | | -Once the image has been built, you can run the website locally: |
| 19 | +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. |
49 | 20 |
|
50 | | -```bash |
51 | | -make docker-serve |
52 | | -``` |
| 21 | +## Get involved with SIG Docs |
53 | 22 |
|
54 | | -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. |
| 23 | +Learn more about SIG Docs Kubernetes community and meetings on the [community page](https://github.com/kubernetes/community/tree/master/sig-docs#meetings). |
55 | 24 |
|
56 | | -## Running the website locally using Hugo |
| 25 | +You can also reach the maintainers of this project at: |
57 | 26 |
|
58 | | -See the [official Hugo documentation](https://gohugo.io/getting-started/installing/) for Hugo installation instructions. Make sure to install the Hugo extended version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L9) file. |
| 27 | +- [Slack](https://kubernetes.slack.com/messages/sig-docs) |
| 28 | +- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) |
59 | 29 |
|
60 | | -To run the website locally when you have Hugo installed: |
| 30 | +## Contributing to the docs |
61 | 31 |
|
62 | | -```bash |
63 | | -make serve |
64 | | -``` |
| 32 | +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. |
65 | 33 |
|
66 | | -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. |
| 34 | +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.** |
67 | 35 |
|
68 | | -## Community, discussion, contribution, and support |
| 36 | +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. |
69 | 37 |
|
70 | | -Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/). |
| 38 | +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. |
71 | 39 |
|
72 | | -You can reach the maintainers of this project at: |
| 40 | +For more information about contributing to the Kubernetes documentation, see: |
73 | 41 |
|
74 | | -- [Slack](https://kubernetes.slack.com/messages/sig-docs) |
75 | | -- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-docs) |
| 42 | +* [Contribute to Kubernetes docs](https://kubernetes.io/docs/contribute/) |
| 43 | +* [Using Page Templates](https://kubernetes.io/docs/contribute/style/page-templates/) |
| 44 | +* [Documentation Style Guide](https://kubernetes.io/docs/contribute/style/style-guide/) |
| 45 | +* [Localizing Kubernetes Documentation](https://kubernetes.io/docs/contribute/localization/) |
| 46 | + |
| 47 | +## Localization `README.md`'s |
| 48 | + |
| 49 | +| Language | Language | |
| 50 | +|---|---| |
| 51 | +|[French](README-fr.md)|[Korean](README-ko.md)| |
| 52 | +|[German](README-de.md)|[Portuguese](README-pt.md)| |
| 53 | +|[Hindi](README-hi.md)|[Spanish](README-es.md)| |
| 54 | +|[Indonesian](README-id.md)|[Chinese](README-zh.md)| |
| 55 | +|[Japanese](README-ja.md)|[Vietnamese](README-vi.md)| |
| 56 | +|[Russian](README-ru.md)|[Italian](README-it.md)| |
| 57 | +|[Polish](README-pl.md)|[Ukrainian](README-uk.md)| |
76 | 58 |
|
77 | | -### Code of conduct |
| 59 | +## Code of conduct |
78 | 60 |
|
79 | | -Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md). |
| 61 | +Participation in the Kubernetes community is governed by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). |
80 | 62 |
|
81 | 63 | ## Thank you! |
82 | 64 |
|
83 | | -Kubernetes thrives on community participation, and we appreciate your contributions to our website and our documentation! |
| 65 | +Kubernetes thrives on community participation, and we appreciate your contributions to our website and our documentation! |
0 commit comments