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
Добро пожаловать! Данный репозиторий содержит все необходимые файлы для сборки [сайта Kubernetes и документации](https://kubernetes.io/). Мы благодарим вас за старания!
5
+
Данный репозиторий содержит все необходимые файлы для сборки [сайта Kubernetes и документации](https://kubernetes.io/). Мы благодарим вас за желание внести свой вклад!
6
6
7
-
## Запуск сайта с помощью Hugo
7
+
#Использование этого репозитория
8
8
9
-
Обратитесь к [официальной документации Hugo](https://gohugo.io/getting-started/installing/), чтобы установить Hugo. Убедитесь, что вы установили правильную версию Hugo, которая устанавливается в переменной окружения `HUGO_VERSION` в файле [`netlify.toml`](netlify.toml#L10).
9
+
Запустить сайт локально можно с помощью Hugo (Extended version) или же в исполняемой среде для контейнеров. Мы настоятельно рекомендуем воспользоваться контейнерной средой, поскольку она обеспечивает консистивность развёртывания с оригинальным сайтом.
10
10
11
-
После установки Hugo, чтобы запустить сайт, выполните в консоли:
11
+
## Предварительные требования
12
12
13
-
```bash
13
+
Чтобы работать с этим репозиторием, понадобятся следующие компоненты, установленные локально:
14
+
15
+
-[npm](https://www.npmjs.com/)
16
+
-[Go](https://golang.org/)
17
+
-[Hugo (Extended version)](https://gohugo.io/)
18
+
- Исполняемая среда для контейнеров вроде [Docker](https://www.docker.com/)
19
+
20
+
Перед тем, как начать, установите зависимости. Склонируйте репозиторий и перейдите в его директорию:
Эта команда запустит сервер Hugo на порту 1313. Откройте браузер и перейдите по ссылке http://localhost:1313, чтобы открыть сайт. Если вы отредактируете исходные файлы сайта, Hugo автоматически применит изменения и обновит страницу в браузере.
27
+
Сайт Kubernetes использует [тему для Hugo под названием Docsy](https://github.com/google/docsy). Даже если вы планируете запускать сайт в контейнере, мы настоятельно рекомендуем загрузить соответствующий подмодуль и другие зависимости для разработки, выполнив следующую команду:
20
28
21
-
## Сообщество, обсуждение, вклад и поддержка
29
+
```
30
+
# загружаем Git-подмодуль Docsy
31
+
git submodule update --init --recursive --depth 1
32
+
```
22
33
23
-
Узнайте, как поучаствовать в жизни сообщества Kubernetes на [странице сообщества](http://kubernetes.io/community/).
34
+
## Запуск сайта в контейнере
24
35
25
-
Вы можете связаться с сопровождающими этого проекта по следующим ссылкам:
36
+
Чтобы собрать сайт в контейнере, выполните следующие команды — они собирают образ контейнера и запускают его:
26
37
27
-
-[Канал в Slack](https://kubernetes.slack.com/messages/sig-docs)
Откройте браузер и перейдите по ссылке http://localhost:1313, чтобы увидеть сайт. Если вы отредактируете исходные файлы сайта, Hugo автоматически обновит сам сайт и выполнит обновление страницы в браузере.
44
+
45
+
## Запуск сайта с помощью Hugo
31
46
32
-
Нажмите на кнопку **Fork** в правом верхнем углу, чтобы создать копию этого репозитория в ваш GitHub-аккаунт. Эта копия называется *форк-репозиторием*. Делайте любые изменения в вашем форк-репозитории, и когда вы будете готовы опубликовать изменения, откройте форк-репозиторий и создайте новый пулреквест, чтобы уведомить нас.
47
+
Убедитесь, что вы установили расширенную версию Hugo (extended version): она определена в переменной окружения `HUGO_VERSION` в файле [`netlify.toml`](netlify.toml#L10).
33
48
34
-
После того, как вы отправите пулреквест, ревьювер Kubernetes даст по нему обратную связь. Вы, как автор пулреквеста, **должны обновить свой пулреквест после его рассмотрения ревьювером Kubernetes.**
49
+
Чтобы собрать и протестировать сайт локально, выполните:
35
50
36
-
Вполне возможно, что более одного ревьювера Kubernetes оставят свои комментарии или даже может быть так, что новый комментарий ревьювера Kubernetes будет отличаться от первоначального назначенного ревьювера. Кроме того, в некоторых случаях один из ревьюверов может запросить технический обзор у [технического ревьювера Kubernetes](https://github.com/kubernetes/website/wiki/Tech-reviewers), если это будет необходимо. Ревьюверы сделают все возможное, чтобы как можно оперативно оставить свои предложения и пожелания, но время ответа может варьироваться в зависимости от обстоятельств.
51
+
```bash
52
+
# install dependencies
53
+
npm ci
54
+
make serve
55
+
```
56
+
57
+
Эти команды запустят локальный сервер Hugo на порту 1313. Откройте браузер и перейдите по ссылке http://localhost:1313, чтобы увидеть сайт. Если вы отредактируете исходные файлы сайта, Hugo автоматически обновит сам сайт и выполнит обновление страницы в браузере.
58
+
59
+
## Решение проблем
60
+
### 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
61
+
62
+
По техническим причинам Hugo поставляется с двумя наборами бинарников. Текущий сайт Kubernetes работает только в версии **Hugo Extended**. На [странице релизов](https://github.com/gohugoio/hugo/releases) ищите архивы со словом `extended` в названии. Чтобы убедиться в корректности, запустите команду `hugo version` и найдите в выводе слово `extended`.
63
+
64
+
### Решение проблемы на macOS с "too many open files"
65
+
66
+
Если вы запускаете `make serve` на macOS и получаете следующую ошибку:
67
+
68
+
```
69
+
ERROR 2020/08/01 19:09:18 Error: listen tcp 127.0.0.1:1313: socket: too many open files
70
+
make: *** [serve] Error 1
71
+
```
72
+
73
+
Попробуйте проверить текущий лимит для открытых файлов:
74
+
75
+
`launchctl limit maxfiles`
76
+
77
+
Затем выполните следующие команды (они взяты и адаптированы из https://gist.github.com/tombigel/d503800a282fcadbee14b537735d202c):
78
+
79
+
```shell
80
+
#!/bin/sh
81
+
82
+
# Ссылки на оригинальные gist-файлы закомментированы в пользу моих адаптированных.
Данное решение работает для macOS Catalina и Mojave.
99
+
100
+
# Участие в SIG Docs
101
+
102
+
Узнайте о Kubernetes-сообществе SIG Docs и его встречах на [странице сообщества](https://github.com/kubernetes/community/tree/master/sig-docs#meetings).
103
+
104
+
Вы можете связаться с сопровождающими этот проект по следующим ссылкам:
105
+
106
+
-[Канал в Slack](https://kubernetes.slack.com/messages/sig-docs) ([получите приглашение в этот Slack](https://slack.k8s.io/))
Нажмите на кнопку **Fork** в правом верхнем углу, чтобы создать копию этого репозитория для вашего GitHub-аккаунта. Эта копия называется *форк-репозиторием*. Делайте любые изменения в своем форк-репозитории и, когда будете готовы опубликовать изменения, зайдите в свой форк-репозиторий и создайте новый pull-запрос (PR), чтобы уведомить нас.
112
+
113
+
После того, как вы отправите pull-запрос, ревьювер из проекта Kubernetes даст по нему обратную связь. Вы, как автор pull-запроса, **должны обновить свой PR после его рассмотрения ревьювером Kubernetes.**
114
+
115
+
Вполне возможно, что более одного ревьювера Kubernetes оставят свои комментарии. Может быть даже так, что вы будете получать обратную связь уже не от того ревьювера, что был первоначально вам назначен. Кроме того, в некоторых случаях один из ревьюверов может запросить техническую рецензию от [технического ревьювера Kubernetes](https://github.com/kubernetes/website/wiki/Tech-reviewers), если это потребуется. Ревьюверы сделают все возможное, чтобы как можно оперативнее оставить свои предложения и пожелания, но время ответа может варьироваться в зависимости от обстоятельств.
37
116
38
117
Узнать подробнее о том, как поучаствовать в документации Kubernetes, вы можете по ссылкам ниже:
39
118
@@ -42,21 +121,22 @@ hugo server --buildFuture
42
121
*[Руководство по оформлению документации](https://kubernetes.io/docs/contribute/style/style-guide/)
43
122
*[Руководство по локализации Kubernetes](https://kubernetes.io/docs/contribute/localization/)
Участие в сообществе Kubernetes регулируется [кодексом поведения CNCF](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
138
+
Участие в сообществе Kubernetes регулируется [кодексом поведения CNCF](https://github.com/cncf/foundation/blob/master/code-of-conduct-languages/ru.md).
59
139
60
-
##Спасибо!
140
+
# Спасибо!
61
141
62
142
Kubernetes процветает благодаря сообществу и мы ценим ваш вклад в сайт и документацию!
0 commit comments