You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!-- 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
7
Вітаємо! В цьому репозиторії міститься все необхідне для роботи над [сайтом і документацією Kubernetes](https://kubernetes.io/). Ми щасливі, що ви хочете зробити свій внесок!
Copy file name to clipboardExpand all lines: README.md
+53-53Lines changed: 53 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,10 @@
4
4
5
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!
6
6
7
-
+[Contributing to the docs](#contributing-to-the-docs)
8
-
+[Localization ReadMes](#localization-readmemds)
7
+
-[Contributing to the docs](#contributing-to-the-docs)
8
+
-[Localization ReadMes](#localization-readmemds)
9
9
10
-
# Using this repository
10
+
##Using this repository
11
11
12
12
You can run the website locally using Hugo (Extended version), or you can run it in a container runtime. We strongly recommend using the container runtime, as it gives deployment consistency with the live website.
13
13
@@ -22,14 +22,14 @@ To use this repository, you need the following installed locally:
22
22
23
23
Before you start, install the dependencies. Clone the repository and navigate to the directory:
The Kubernetes website uses the [Docsy Hugo theme](https://github.com/google/docsy#readme). Even if you plan to run the website in a container, we strongly recommend pulling in the submodule and other development dependencies by running the following:
To build the site in a container, run the following to build the container image and run it:
40
40
41
-
```
41
+
```bash
42
42
make container-image
43
43
make container-serve
44
44
```
45
45
46
46
If you see errors, it probably means that the hugo container did not have enough computing resources available. To solve it, increase the amount of allowed CPU and memory usage for Docker on your machine ([MacOSX](https://docs.docker.com/docker-for-mac/#resources) and [Windows](https://docs.docker.com/docker-for-windows/#resources)).
47
47
48
-
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.
48
+
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
49
50
50
## Running the website locally using Hugo
51
51
@@ -59,54 +59,55 @@ npm ci
59
59
make serve
60
60
```
61
61
62
-
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.
62
+
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.
63
63
64
64
## Building the API reference pages
65
65
66
-
The API reference pages located in `content/en/docs/reference/kubernetes-api` are built from the Swagger specification, using https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs.
66
+
The API reference pages located in `content/en/docs/reference/kubernetes-api` are built from the Swagger specification, using <https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs>.
67
67
68
68
To update the reference pages for a new Kubernetes release (replace v1.20 in the following examples with the release to update to):
69
69
70
70
1. Pull the `kubernetes-resources-reference` submodule:
71
71
72
-
```
73
-
git submodule update --init --recursive --depth 1
74
-
```
72
+
```bash
73
+
git submodule update --init --recursive --depth 1
74
+
```
75
75
76
76
2. Create a new API revision into the submodule, and add the Swagger specification:
4. Adapt the files `toc.yaml` and `fields.yaml` to reflect the changes between the two releases
91
91
92
92
5. Next, build the pages:
93
93
94
-
```
95
-
make api-reference
96
-
```
94
+
```bash
95
+
make api-reference
96
+
```
97
97
98
-
You can test the results locally by making and serving the site from a container image:
98
+
You can test the results locally by making and serving the site from a container image:
99
99
100
-
```
101
-
make container-image
102
-
make container-serve
103
-
```
100
+
```bash
101
+
make container-image
102
+
make container-serve
103
+
```
104
104
105
-
In a web browser, go to http://localhost:1313/docs/reference/kubernetes-api/ to view the API reference.
105
+
In a web browser, go to <http://localhost:1313/docs/reference/kubernetes-api/> to view the API reference.
106
106
107
107
6. When all changes of the new contract are reflected into the configuration files `toc.yaml` and `fields.yaml`, create a Pull Request with the newly generated API reference pages.
108
108
109
109
## Troubleshooting
110
+
110
111
### error: failed to transform resource: TOCSS: failed to transform "scss/main.scss" (text/x-scss): this feature is not available in your current Hugo version
111
112
112
113
Hugo is shipped in two set of binaries for technical reasons. The current website runs based on the **Hugo Extended** version only. In the [release page](https://github.com/gohugoio/hugo/releases) look for archives with `extended` in the name. To confirm, run `hugo version` and look for the word `extended`.
@@ -115,7 +116,7 @@ Hugo is shipped in two set of binaries for technical reasons. The current websit
115
116
116
117
If you run `make serve` on macOS and receive the following error:
117
118
118
-
```
119
+
```bash
119
120
ERROR 2020/08/01 19:09:18 Error: listen tcp 127.0.0.1:1313: socket: too many open files
120
121
make: *** [serve] Error 1
121
122
```
@@ -124,7 +125,7 @@ Try checking the current limit for open files:
124
125
125
126
`launchctl limit maxfiles`
126
127
127
-
Then run the following commands (adapted from https://gist.github.com/tombigel/d503800a282fcadbee14b537735d202c):
128
+
Then run the following commands (adapted from <https://gist.github.com/tombigel/d503800a282fcadbee14b537735d202c>):
Learn more about SIG Docs Kubernetes community and meetings on the [community page](https://github.com/kubernetes/community/tree/master/sig-docs#meetings).
154
154
@@ -157,39 +157,39 @@ You can also reach the maintainers of this project at:
157
157
-[Slack](https://kubernetes.slack.com/messages/sig-docs)[Get an invite for this Slack](https://slack.k8s.io/)
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.
162
+
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.
163
163
164
-
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.**
164
+
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.**
165
165
166
166
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.
167
167
168
-
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.
168
+
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.
169
169
170
170
For more information about contributing to the Kubernetes documentation, see:
171
171
172
-
*[Contribute to Kubernetes docs](https://kubernetes.io/docs/contribute/)
Participation in the Kubernetes community is governed by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
192
192
193
-
# Thank you!
193
+
##Thank you
194
194
195
195
Kubernetes thrives on community participation, and we appreciate your contributions to our website and our documentation!
0 commit comments