Розширена участь

Ця сторінка передбачає, що ви вже знаєте, як додавати новий контент та перевіряти роботу інших, і готові дізнатися більше про способи участі. Вам потрібно використовувати командний рядок Git та інші інструменти для виконання деяких з цих завдань.

Пропонування покращень

Члени SIG Docs можуть пропонувати покращення.

Після того, як ви вже деякий час вносите зміни в документацію Kubernetes, у вас можуть зʼявитися ідеї щодо покращення настанов зі стилю, настанов з контенту, інструментів, які використовуються для створення документації, стилю вебсайту, процесів перевірки та злиття pull request-ів, або інших аспектів документації. Для забезпечення максимальної прозорості ці пропозиції повинні обговорюватися на зустрічі SIG Docs або у списку розсилки kubernetes-sig-docs. Крім того, корисно мати певний контекст щодо того, як все зараз працює і чому в минулому були прийняті певні рішення, перш ніж пропонувати кардинальні зміни. Найшвидший спосіб отримати відповіді на запитання про те, як працює документація, — запитати в каналі #sig-docs на kubernetes.slack.com.

Після того, як обговорення відбулося, і SIG Docs погодився щодо бажаного результату, ви можете працювати над запропонованими змінами найбільш відповідним чином. Наприклад, оновлення керівництва зі стилю або функціональності вебсайту може включати відкриття pull request, тоді як зміна, повʼязана з тестуванням документації, може передбачати співпрацю з sig-testing.

Координація документації для випуску Kubernetes

Затверджувачі SIG Docs можуть координувати документацію для випуску Kubernetes.

Кожен випуск Kubernetes координується командою, яка бере участь у робочій групі (SIG) sig-release. Серед інших членів команди випуску: загальний керівник випуску, а також представники sig-testing та інші. Щоб дізнатися більше про процеси випуску Kubernetes, зверніться до https://github.com/kubernetes/sig-release.

Представник SIG Docs для даного випуску координує наступні завдання:

• Моніторинг електронної таблиці для відстеження функцій щодо нових або змінених функцій, які впливають на документацію. Якщо документація для певної функції не буде готова до випуску, ця функція може не бути включена у випуск.
• Регулярне відвідування зустрічей sig-release та надання оновлень про статус документації для випуску.
• Перегляд та редагування документації для функцій, підготовлених SIG, відповідальним за реалізацію функції.
• Злиття pull request-ів, повʼязаних з випуском, і підтримка гілки Git для випуску.
• Наставництво інших учасників SIG Docs, які хочуть навчитися виконувати цю роль у майбутньому. Це називається "shadowing".
• Публікація змін у документації, повʼязаних з випуском, коли публікуються артефакти випуску.

Координація випуску зазвичай займає 3-4 місяці, і цей обовʼязок передається між затверджувачами SIG Docs.

Виконання обовʼязків New Contributor Ambassador

Затверджувачі SIG Docs можуть бути New Contributor Ambassador.

Помічники для нових учасників вітають нових учасників SIG-Docs, пропонують PRʼи новим учасникам та наставляють нових учасників через їх перші кілька PR-ів.

ОбовʼязкиNew Contributor Ambassador включають:

• Моніторинг каналу #sig-docs Slack на предмет запитань від нових учасників.
• Співпраця з керівниками PRʼів для ідентифікації good first issues для нових учасників.
• Наставництво нових учасників через їхні перші кілька PRʼів до репозиторію документації.
• Допомога новим учасникам у створенні складніших PRʼів, необхідних їм для того, щоб стати членами Kubernetes.
• Поручительство за учасників на їхньому шляху до членства у Kubernetes.
• Проведення щомісячної зустрічі для допомоги та наставництва нових учасників.

Поточні Амбасадори нових учасників оголошуються на кожній зустрічі SIG-Docs та в каналі #sig-docs Kubernetes.

Поручительство за нового учасника

Рецензенти SIG Docs можуть бути поручителями нових учасників.

Після того, як новий учасник успішно подав 5 значних pull requestʼів до одного або кількох репозиторіїв Kubernetes, він має право подати заявку на членство в організації Kubernetes. Членство учасника повинно бути підтримано двома поручителями, які вже є рецензентами.

Нові учасники документації можуть запитати поручителів, запитавши в каналі #sig-docs на Slack Kubernetes або у списку розсилки SIG Docs. Якщо ви впевнені в роботі заявника, ви можете добровільно поручитись за нього. Коли кандидати подають свою заявку на членство, відповідайте на заявку з "+1" і включайте деталі про те, чому ви вважаєте, що заявник добре підходить для членства в організації Kubernetes.

Виконання обовʼязків співголови SIG

Члени SIG Docs можуть бути співголовою SIG Docs.

Вимоги

Член Kubernetes повинен відповідати наступним вимогам для того, щоб бути співголовою:

• Розуміти робочі процеси та інструментарій SIG Docs: git, Hugo, локалізація, блог.
• Розуміти, як інші SIG Kubernetes та репозиторії впливають на робочий процес SIG Docs, включаючи: команди в k/org, процеси в k/community, втулки в k/test-infra, та роль SIG Architecture. Крім того, розуміти, як працює процес випуску документації Kubernetes.
• Отримати схвалення від спільноти SIG Docs або безпосередньо, або за допомогою консенсусу.
• Виділяти принаймні 5 годин на тиждень (і часто більше) на цю роль протягом мінімум 6 місяців.

Обовʼязки

Роль співголови полягає в обслуговуванні: співголови підвищують можливості учасників, керують процесами та політикою, організовують та проводять зустрічі, планують роботу сортувальників PR-ів, висвітлюють важливість документації в спільноті Kubernetes, забезпечують успішне завершення випусків документації та фокусують SIG Docs на ефективних пріоритетах.

Обовʼязки включають:

• Фокусування SIG Docs на максимальному задоволенні розробників через відмінну документацію
• Втілення кодексу поведінки спільноти та відповідальність за його дотримання серед членів SIG
• Вивчення та встановлення найкращих практик для SIG шляхом оновлення рекомендацій щодо внесення змін
• Організація та проведення зустрічей SIG: щотижневі оновлення статусу, щоквартальні ретроспективи/планування та інші за потребою
• Організація та проведення спринтів документації на заходах KubeCon та інших конференціях
• Рекрутинг та захист інтересів SIG Docs у CNCF та її платинових партнерів, включаючи Google, Oracle, Azure, IBM та Huawei
• Забезпечення безперебійної роботи SIG

Ефективне проведення зустрічей

Щоб організовувати та проводити ефективні зустрічі, вони спрямовують, що робити, як це робити та чому.

Дотримуйтесь кодексу поведінки спільноти:

• Проводьте шанобливі, інклюзивні дискусії, використовуючи шанобливу, інклюзивну мову.

Встановіть чіткий порядок денний:

• Встановіть чіткий порядок денний тем
• Опублікуйте порядок денний заздалегідь

Для щотижневих зустрічей скопіюйте нотатки з попереднього тижня у розділ "Минулі зустрічі" нотаток

Співпрацюйте для точних нотаток:

• Записуйте обговорення зустрічі
• Розгляньте можливість делегування ролі стенографіста

Чітко та точно призначайте дії:

• Записуйте завдання, відповідального за нього та очікувану дату виконання

Модеруйте за потребою:

• Якщо обговорення відходить від порядку денного, поверніть учасників до поточної теми
• Забезпечте різні стилі обговорення, зберігаючи фокус та поважаючи час учасників

Повага до часу учасників:

Починайте і закінчуйте зустрічі вчасно.

Ефективне використання Zoom:

• Ознайомтесь з керівництвом Zoom для Kubernetes
• Займіть роль ведучого під час входу, ввівши ключ

Запис зустрічей в Zoom

Коли ви готові розпочати запис, натисніть "Record to Cloud".

Коли ви готові зупинити запис, натисніть "Stop".

Відео автоматично завантажується на YouTube.

Завершення роботи співголови SIG (Emeritus)

Дивіться: k/community/sig-docs/offboarding.md