SIG Docs — одна з груп за інтересами (special interest groups) у проєкті Kubernetes, яка займається написанням, оновленням і підтримкою документації Kubernetes загалом. Докладніше про цю SIG див. SIG Docs у репозиторії спільноти на GitHub.
SIG Docs вітає вміст і рецензії від усіх учасників. Будь-хто може відкрити pull request (PR), і будь-хто може створювати тікети щодо вмісту або коментувати pull request, над якими ще триває робота.
Ви також можете стати членом, рецензентом або затверджувачем. Ці ролі потребують ширшого доступу й передбачають певні обовʼязки щодо затвердження та внесення змін. Докладніше про те, як працює членство в спільноті Kubernetes, див. community-membership.
Решта цього документа описує деякі унікальні способи функціонування цих ролей у SIG Docs, яка відповідає за підтримку одного з найбільш публічно орієнтованих аспектів Kubernetes — вебсайту та документації Kubernetes.
Кожна SIG, зокрема SIG Docs, обирає одного або кількох членів SIG на роль голів. Вони є контактними особами між SIG Docs та іншими частинами організації Kubernetes. Від них вимагається глибоке знання структури проєкту Kubernetes загалом і того, як у ньому працює SIG Docs. Актуальний список голів див. у Leadership.
Автоматизація в SIG Docs спирається на два різні механізми: команди GitHub і файли OWNERS.
Існує дві категорії команд SIG Docs у GitHub:
@sig-docs-{language}-owners — затверджувачі та лідери@sig-docs-{language}-reviews — рецензентиДо кожної з них можна звернутися через її @name у коментарях на GitHub, щоб написати всім у цій групі.
Іноді команди Prow і GitHub перетинаються, але не збігаються повністю. Для призначення тікетів і pull request, а також для підтримки затвердження PR автоматизація використовує інформацію з файлів OWNERS.
Проєкт Kubernetes використовує інструмент автоматизації prow для автоматизації, повʼязаної з тікетами та pull request на GitHub. Репозиторій вебсайту Kubernetes використовує два втулки prow:
Ці два втулки використовують файли OWNERS та OWNERS_ALIASES на верхньому рівні репозиторію kubernetes/website GitHub для контролю роботи prow у репозиторії.
Файл OWNERS містить список людей, які є рецензентами та затверджувачами SIG Docs. Файли OWNERS також можуть існувати в підтеках та можуть перевизначати, хто може виступати як рецензент або затверджувач файлів у цій теці та вкладених теках. Для отримання додаткової інформації про файли OWNERS в цілому дивіться OWNERS.
Крім того, окремий файл Markdown може містити у своєму front-matter список рецензентів і затверджувачів — окремі імена користувачів GitHub або групи GitHub.
Комбінація файлів OWNERS і front-matter у файлах Markdown визначає поради, які власники PR отримують від автоматизованих систем щодо того, кого попросити про технічне та редакторське рецензування їхнього PR.
Коли pull request зливають у гілку, з якої публікується вміст, цей вміст публікується на https://kubernetes.io. Щоб забезпечити високу якість опублікованого вмісту, ми дозволяємо зливати pull request лише затверджувачам SIG Docs. Ось як це працює.
lgtm та approve, не має міток hold та всі тести проходять успішно, pull request зливається автоматично./hold або утримуючись від коментаря /lgtm).lgtm, додавши коментар /lgtm./approve. Деякі затверджувачі також виконують додаткові ролі, як-от відповідальний за PR або голова SIG Docs.Щоб дізнатися більше про участь у SIG Docs, див.:
Докладніше про внесок у документацію Kubernetes див.: