Покращення документації Kubernetes
Цей вебсайт підтримується робочою групою Kubernetes SIG Docs. Проєкт Kubernetes вітає допомогу від усіх учасників, незалежно від їхнього досвіду!
Учасники, які мають намір працювати з документацією Kubernetes можуть:
- Вдосконалювати наявний вміст
- Створювати новий вміст
- Перекладати документацію
- Керувати та публікувати документацію під час релізного циклу Kubernetes
Команда блогів, частина SIG Docs, допомагає керувати офіційними блогами. Щоб дізнатися більше, прочитайте участь у блогах Kubernetes.
Примітка:
Щоб дізнатися більше про те, як зробити свій внесок в Kubernetes загалом, перегляньте загальний сайт документації для учасників.Початок роботи
Будь-хто може відкрити тікет щодо документації або внести зміни через запит на злиття (PR) в репозиторій GitHub kubernetes/website. Для ефективної роботи в спільноті Kubernetes вам слід вміти працювати з
git та GitHub.
Для того, щоб долучитись до роботи з документацією:
- Ознайомтесь та підпишіть CNCF Contributor License Agreement.
- Ознайомтесь з репозиторієм документації та генератором статичних вебсайтів.
- Переконайтесь, що ви розумієте базові вимоги щодо відкриття запиту на злиття та процесу рецензування змін.
вміст]
N --- O[Перекладіть
документацію]
O --- P[Керуйте/Публікуйте
документацію релізного
циклу K8s]
end
subgraph second[Огляд]
direction TB
T[ ] -.-
D[Огляньте репозиторій
kubernetes/website] --- E[Ознайомтесь з
генератором статичних
сайтів Hugo]
E --- F[Оновіть відомості про
основні команди GitHub]
F --- G[Робіть огляд
відкритих PR
та змін]
end
subgraph first[Реєстрація]
direction TB
S[ ] -.-
B[Підпишіть CNCF
Contributor
License Agreement] --- C[Приєднайтесь до
каналу sig-docs
в Slack]
C --- V[Приєднайтесь до
списку розсилки
kubernetes-sig-docs]
V --- M[Відвідуйте тижневі
заходи sig-docs
чи зустрічі в slack]
end
A([fa:fa-user Новий
учасник]) --> first
A --> second
A --> third
A --> H[Ставте питання!!!]
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,M,Q,N,O,P,V grey
class S,T,U spacewhite
class first,second,third white
На схемі 1 зображено шлях для нового учасника. Ви можете виконати деякі або всі етапи з Реєстрації та Огляду. Тепер ви готові відкривати PR (запити на злиття), щоб досягти своїх цілей, деякі з яких перелічені в Створення PR. Знову ж таки, не соромтесь ставити питання, питання завжди вітаються!
Деякі завдання вимагають більшого рівня довіри та більшого доступу в організації Kubernetes. Докладнішу інформацію щодо ролей та дозволів дивіться в розділі Участь в SIG Docs.
Ваш перший внесок
Ви можете підготуватися до свого першого внеску, розглянувши кілька кроків перед тим. Схема 2 описує кроки, а опис міститься далі.
від інших учасників K8s] -->
A[Ознайомтесь з переліком тікетів
на kubernetes/website
щоб знайти щось для першого PR] --> B[Створіть PR!!]
end
subgraph first[Підготовчі кроки]
direction TB
T[ ] -.-
D[Ознайомтесь з описом внеску] -->E[Ознайомтесь з настановами
щодо вмісту та стилю K8s]
E --> F[Дізнайтесь про типи вмісту
сторінок 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,D,E,F,G grey
class S,T spacewhite
class first,second white
- Прочитайте Як робити внесок, щоб дізнатися про різні способи, якими ви можете зробити свій внесок.
- Ознайомтесь зі списком тікетів на
kubernetes/websiteна предмет наявності питань, які можуть бути гарними точками входу. - Відкрийте запит на злиття на GitHub до наявної документації та дізнайтеся більше про створення тікетів на GitHub.
- Рецензуйте запити на злиття від інших учасників спільноти Kubernetes на предмет точності та мови.
- Прочитайте поради щодо вмісту та стилю Kubernetes, щоб залишати обґрунтовані коментарі.
- Дізнайтеся про типи вмісту сторінок та Hugo shortcodes.
Отримання допомоги щодо участі
Зробити перший внесок може бути дуже складно. Помічники для нових учасників (New Contributor Ambassador) готові провести вас через створення вашого першого внеску. Ви можете звертатися до них в Slack Kubernetes, переважно в каналі #sig-docs. Також є Зустрічі з новими учасниками, яка відбувається першого вівторка кожного місяця. Ви можете спілкуватися з помічниками для нових учасників та отримати відповіді на свої запитання там.
Наступні кроки
- Навчіться працювати з локальним клоном репозиторію.
- Документуйте функції у випуску.
- Беріть участь в SIG Docs і станьте учасником або рецензентом.
- Розпочинайте або допомагайте з локалізацією.
Приєднуйтеся до SIG Docs
SIG Docs — це група учасників, які публікують та підтримують документацію Kubernetes та цей вебсайт. Участь в SIG Docs — це гарний спосіб для учасників Kubernetes (розробка функцій чи інше) зробити значний внесок у проєкт Kubernetes.
SIG Docs спілкується за допомогою різних інструментів:
- Приєднуйтесь до
#sig-docsв Kubernetes Slack. Не забудьте представитися! - Приєднуйтесь до списку розсилки
kubernetes-sig-docs, де відбуваються ширші обговорення та записуються офіційні рішення. - Приєднуйтесь до відеозустрічей SIG Docs щотижня. Зустрічі завжди оголошуються в
#sig-docsта додаються до календаря зустрічей спільноти Kubernetes. Вам слід завантажити клієнт Zoom або долучитися за допомоги телефону. - Приєднуйтесь до асинхронних зустрічей в Slack SIG Docs в ті тижні, коли відбувається відеозустріч віч-на-віч. Зустрічі завжди оголошуються в
#sig-docs. Ви можете зробити внесок до будь-якого з тредів протягом 24 годин після оголошення зустрічі.
Інші способи зробити внесок
- Відвідайте сайт спільноти Kubernetes. Беріть участь в Twitter або Stack Overflow, дізнайтеся про місцеві зустрічі та події Kubernetes та інше.
- Прочитайте шпаргалку для учасників для участі у розробці функцій Kubernetes.
- Відвідайте сайт учасника, щоб дізнатися більше про учасників Kubernetes та додаткові ресурси для учасників.
- Пишіть пости в блог
- Подавайте приклади використання