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
7
-[Внесок до документації](#внесок-до-документації)
Ви можете запустити вебсайт локально, використовуючи [Hugo (розширена версія)](https://gohugo.io/), або ви можете запустити його в контейнерному середовищі. Ми настійно рекомендуємо використовувати контейнерне середовище, оскільки воно забезпечує однорідність розгортання порівняно з основним вебсайтом.
12
+
Ви можете запустити вебсайт локально, використовуючи [Hugo (розширена версія)](https://gohugo.io/), або ви можете запустити його в контейнерному середовищі. Ми наполегливо рекомендуємо використовувати контейнерне середовище, оскільки воно забезпечує однорідність розгортання та подібність до основного вебсайту.
13
13
14
-
## Передумови
14
+
## Необхідні умови
15
15
16
16
Для користування цим репозиторієм вам потрібно локально встановити наступні інструменти:
17
17
@@ -20,22 +20,27 @@
20
20
-[Hugo (Розширена версія)](https://gohugo.io/)
21
21
- Середовище запуску контейнерів, наприклад [Docker](https://www.docker.com/).
22
22
23
+
> [!NOTE]
24
+
Переконайтеся, що ви встановили розширену версію Hugo, визначену змінною оточення `HUGO_VERSION` у файлі [`netlify.toml`](netlify.toml#L11).
25
+
23
26
Перед тим як розпочати, встановіть залежності. Зробіть клон репозиторію та перейдіть в теку:
Сайт Kubernetes використовує [Docsy Hugo theme](https://github.com/google/docsy#readme). Навіть якщо ви плануєте запускати вебсайт в контейнері, ми настійливо рекомендуємо встановити субмодулі та інші залежності зробивши наступне:
33
+
Сайт Kubernetes використовує [тему Docsy для Hugo](https://github.com/google/docsy#readme), яка встановлюється за допомогою npm. Ви можете також завантажити образ контейнера для локальної розробки, який вже містить Hugo та Docsy. Крім того, субмодуль Git використовується для інструментів, які генерують довідкову документацію.
31
34
32
35
### Windows
36
+
33
37
```powershell
34
38
# отримання залежностей субмодулів
35
39
git submodule update --init --recursive --depth 1
36
40
```
37
41
38
42
### Linux / інші Unix
43
+
39
44
```bash
40
45
# отримання залежностей субмодулів
41
46
make module-init
@@ -46,38 +51,59 @@ make module-init
46
51
Для збирання вебсайту з використанням контейнера, зробіть наступне:
47
52
48
53
```bash
49
-
# Ви можете встановити у $CONTAINER_ENGINE назву будь-якого Docker-подібного інструменту
54
+
# Ви можете встановити у $CONTAINER_ENGINE назву будь-якого Docker-подібного інструмента
55
+
56
+
# Створення всього вебсайту
50
57
make container-serve
58
+
59
+
# Або, якщо ви хочете лише згенерувати лише певну мову (напр. англійську)
60
+
make container-serve segments=en
61
+
62
+
# Якшо ви хочете згенерувати кілька мов (напр. англійську та українську)
63
+
make container-serve segments=en,uk
51
64
```
52
65
53
-
Якщо ви бачите помилку, скоріш за все це означає, що контейнеру hugo не вистачило обчислювальних ресурсів. Для її розвʼязання збільште обсяг процесорних потужностей та памʼяті для Docker у себе на компʼютері ([MacOS](https://docs.docker.com/desktop/settings/mac/) та [Windows](https://docs.docker.com/desktop/settings/windows/)).
66
+
**💡 Порада:** Використання _Hugo segments_ прискорює створення локальної збірки для попереднього перегляду шляхом обробки контенту лише для зазначених мов.
67
+
68
+
Якщо ви бачите помилку, скоріш за все це означає, що контейнеру Hugo не вистачило обчислювальних ресурсів. Для її розвʼязання збільште обсяг процесорних потужностей та памʼяті для Docker у себе на компʼютері ([macOS](https://docs.docker.com/desktop/settings/mac/) та [Windows](https://docs.docker.com/desktop/settings/windows/)).
54
69
55
70
Відкрийте у себе в оглядачі адресу <http://localhost:1313> для перегляду локального вебсайту. По міри того, як ви вноситимете зміни в сирці, Hugo оновлюватиме вебсайт та перезавантажуватиме сторінку в оглядачі.
56
71
57
72
## Запуск сайт локально з використанням Hugo
58
73
59
-
Переконайтесь, що ви встановили розширену версію Hugo яку вказано у змінній оточення `HUGO_VERSION` файлу [`netlify.toml`](netlify.toml#L11).
60
-
61
74
Для встановлення залежностей, розгорніть та перевірте сайт локально:
62
75
63
-
- На macOS та Linux
76
+
- В macOS та Linux
77
+
64
78
```bash
65
79
npm ci
80
+
81
+
# Якщо ви хочете згенерувати повну версію сайту
66
82
make serve
83
+
84
+
# Або, якщо ви хочете згенерувати лише певну мову
85
+
make serve segments=en
86
+
87
+
# Якщо ви хочете згенерувати кілька мов
88
+
make serve segments=en,uk
67
89
```
68
-
- На Windows (PowerShell)
90
+
91
+
**💡 Порада:**_Hugo segments_ визначаються в `hugo.toml` та дозволяють генерувати контент лише для зазначених мов.
92
+
93
+
- У Windows (PowerShell)
94
+
69
95
```powershell
70
96
npm ci
71
97
hugo.exe server --buildFuture --environment development
72
98
```
73
99
74
100
Це призведе до запуску локального сервера Hugo, який відповідатиме на запити на порту 1313. Відкрийте у себе в оглядачі адресу <http://localhost:1313> для перегляду локального вебсайту. По міри того, як ви вноситимете зміни в сирці, Hugo оновлюватиме вебсайт та перезавантажуватиме сторінку в оглядачі.
75
101
76
-
## Створення довідкових сторінок API
102
+
## Створення сторінок довідки API
77
103
78
104
Довідкові сторінки API, розташовані в `content/en/docs/reference/kubernetes-api`, створюються на основі специфікації Swagger, також відомої як специфікація OpenAPI, за допомогою <https://github.com/kubernetes-sigs/reference-docs/tree/master/gen-resourcesdocs>.
79
105
80
-
Для оновлення довідкових сторінок для нового випуску Kubernetes виконайте наступні кроки:
106
+
Для оновлення сторінок довідки для нового випуску Kubernetes виконайте наступні кроки:
81
107
82
108
1. Отримайте субмодуль `api-ref-generator`:
83
109
@@ -93,7 +119,7 @@ make container-serve
93
119
94
120
3. В `api-ref-assets/config/`, змініть файли `toc.yaml` та `fields.yaml`, так щоб вони вказували на новий випуск.
95
121
96
-
4. Далі, зберіть сторінки:
122
+
4. Далі, створіть сторінки:
97
123
98
124
```bash
99
125
make api-reference
@@ -102,7 +128,6 @@ make container-serve
102
128
Ви можете протестувати результати локально запустивши сайт з образу контейнера:
103
129
104
130
```bash
105
-
make container-image
106
131
make container-serve
107
132
```
108
133
@@ -114,7 +139,7 @@ make container-serve
114
139
115
140
### 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
116
141
117
-
Hugo має два виконуваних файли з технічних причин. Поточний вебсайт запускається лише на **Hugo Extended**. На сторінці [release page](https://github.com/gohugoio/hugo/releases) шукайте архів з `extended`в назві. Для перевірки запустіть`hugo version` та шукайте слово `extended` у виводі.
142
+
Hugo має два виконуваних файли з технічних причин. Поточний вебсайт запускається лише на **Hugo Extended**. На сторінці [release page](https://github.com/gohugoio/hugo/releases) шукайте архів з `extended` в назві. Для перевірки запустіть `hugo version` та шукайте слово `extended` у виводі.
118
143
119
144
### Усунення несправностей в macOS для занадто великої кількості відкритих файлів
Ви можете натиснути кнопку **Fork** у верхній правій частині екрана, щоб створити копію цього репозиторію у своєму обліковому записі GitHub. Ця копія називається _fork_ (відгалуження). Вносьте будь-які зміни, які ви хочете у своєму відгалуженні, і коли ви будете готові надіслати ці зміни нам, перейдіть до нього та створіть новий pull request (запит на втягування), щоб повідомити нас про це.
168
193
169
-
Після створення вашого запиту на втягування, рецензент Kubernetes візьме на себе відповідальність за надання чіткого та практичного відгуку. Як власник запиту на втягування, **вам належить внести зміни до вашого запиту на втягування, щоб відповісти на отриманий відгук від рецензента Kubernetes.**
194
+
Після створення вашого запиту на втягування, рецензент Kubernetes візьме на себе відповідальність за надання чіткого та практичного відгуку. Як власнику запиту на втягування, **вам належить внести зміни до вашого запиту на втягування, щоб відповісти на отриманий відгук від рецензента Kubernetes.**
170
195
171
-
Крім того, зверніть увагу, що у вас може бути більше одного рецензента Kubernetes, який надасть вам відгук, або ви можете отримати зворотний звʼязок від рецензента Kubernetes, який відрізняється від того, який спочатку був призначений для надання вам зворотного звʼязку.
196
+
Також зауважте, що ви можете отримати відгук від кількох рецензентів Kubernetes, або ви можете отримати відгук від іншого рецензента Kubernetes, ніж того, який спочатку був призначений для надання вам відгуку.
172
197
173
198
Крім того, в деяких випадках один з ваших рецензентів може попросити технічний огляд у технічного рецензента Kubernetes, коли це необхідно. Рецензенти зроблять все можливе, щоб своєчасно надати відгук, але час відповіді може змінюватися залежно від обставин.
174
199
175
-
Для отримання додаткової інформації про внесок у документацію Kubernetes див.:
200
+
Для отримання додаткової інформації про створення документації Kubernetes див.:
176
201
177
202
-[Участь в створені документації Kubernetes](https://kubernetes.io/docs/contribute/)
Якщо вам потрібна допомога в будь-який момент, коли ви робите свій внесок, [помічник для нових учасників](https://kubernetes.io/docs/contribute/advanced/#serve-as-a-new-contributor-ambassador) є тою особою, до якої варто звертатись. Вони затверджують роботу інших в SIG Docs, їх обов'язки включають наставництво нових учасників та допомогу їм у перших кількох запитах на злиття змін. Найкращим місцем для звʼязку з помічниками є [Kubernetes Slack](https://slack.k8s.io/). Поточні помічники в SIG Docs:
210
+
Якщо вам потрібна допомога в будь-який момент, коли ви робите свій внесок, [помічник для нових учасників](https://kubernetes.io/docs/contribute/advanced/#serve-as-a-new-contributor-ambassador) є тою особою, до якої варто звертатись. Вони затверджують роботу інших в SIG Docs, їх обовʼязки включають наставництво нових учасників та допомогу їм у перших кількох запитах на злиття змін. Найкращим місцем для звʼязку з помічниками є [Kubernetes Slack](https://slack.k8s.io/). Поточні помічники в SIG Docs:
0 commit comments