Створення нового контенту

Цей розділ містить інформацію, яку слід знати перед тим, як створювати новий контент.

flowchart LR subgraph second[Перш ніж розпочати] direction TB S[ ] -.- A[Підпишіть CNCF CLA] --> B[Оберіть гілку Git] B --> C[Одна мова на PR] C --> F[Ознайомтесь з
інструментами для участі] end subgraph first[Основи участі] direction TB T[ ] -.- D[Пишіть документи в markdown
та збирайте сайт за допомогою Hugo] --- E[сирці на GitHub] E --- G[Тека '/content/../docs' містить документи
для кількох мов] G --- H[Ознайомтесь з типом вмісту сторінок Hugo
та shortcodes] end first ----> second classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,C,D,E,F,G,H grey class S,T spacewhite class first,second white

Схема — Підготовка до створення нового контенту

Вище показана інформація, яку слід знати перед надсиланням нового контенту. Деталі наведені нижче.

Основи участі

  • Пишіть документацію Kubernetes у Markdown та збирайте сайт Kubernetes за допомогою Hugo.
  • Документація Kubernetes використовує CommonMark варіант Markdown.
  • Сирці знаходяться на GitHub. Ви можете знайти документацію Kubernetes в /content/en/docs/. Частина довідкової документації автоматично генерується зі скриптів у теці update-imported-docs/.
  • Типи вмісту сторінок описують вигляд вмісту документації в Hugo.
  • Ви можете використовувати Docsy shortcodes або власні Hugo shortcodes, щоб зробити внесок у документацію Kubernetes.
  • Крім стандартних Hugo shortcodes, ми використовуємо кілька власних Hugo shortcodes у нашій документації для керування процесом обробки вмісту.
  • Сирці документації доступні кількома мовами в /content/. Кожна мова має свою теку з дволітерним кодом, визначеним ISO 639-1 стандартом. Наприклад, сирці документації англійською мовою зберігається в /content/en/docs/, української — /content/uk/docs/, відповідно.
  • Для отримання додаткової інформації про роботу з документацією кількома мовами або початку нової локалізації, див. локалізація.

Перш ніж розпочати

Підпишіть CNCF CLA

Усі учасники Kubernetes повинні ознайомитись з Настановами для учасників та підписати Угоду про ліцензування внесків (CLA, Contributor License Agreement).

Pull requests від учасників, які не підписали CLA, не пройдуть автоматизовані тести. Імʼя та електронна адреса, які ви надаєте, повинні збігатися з тими, що знаходяться у вашій конфігурації git config, а ваше імʼя та електронна адреса в git повинні збігатися з тими, що використовуються для CNCF CLA.

Оберіть гілку Git для використання

Відкриваючи pull request, ви повинні заздалегідь знати, яку гілку взяти за основу для своєї роботи.

СценарійГілка
Поточний або новий контент англійською мовою для поточного випускуmain
Контент для випуску змін функційГілка, яка відповідає основній та мінорній версії, у якій відбувається зміна функцій, використовуючи шаблон dev-<version>. Наприклад, якщо функція змінюється у випуску v1.32, то додайте зміни до документації у гілку dev-1.32.
Контент іншими мовами (локалізація)Використовуйте домовленості локалізації. Див. Стратегію створення гілок локалізації для отримання додаткової інформації.

Якщо ви все ще не впевнені, яку гілку обрати, запитайте у #sig-docs в Slack.

Мови в одному PR

Обмежуйте pull requests однією мовою на PR. Якщо вам потрібно внести однакові зміни до одного і того ж зразка коду кількома мовами, відкрийте окремий PR для кожної мови.

Інструменти

Тека інструменти для учасників в репозиторії kubernetes/website містить інструменти, які допоможуть зробити вашу участь в створенні документації простішою.

Створення pull request

Документування функцій для випуску

Дописи в блог та приклади використань

Змінено August 10, 2024 at 8:09 PM PST: Local links were prefixed with "uk" (7d9a96f799)