Black lives matter.
We stand in solidarity with the Black community.
Racism is unacceptable.
It conflicts with the core values of the Kubernetes project and our community does not tolerate it.
Участие в документации Kubernetes
Если вы хотите внести свой вклад в документацию или сайт Kubernetes, мы будем рады вашей помощи! Любой может принять участие в проекте, независимо от того, знакомы ли вы с проектом или нет, кроме этого не имеет значения кто вы — разработчик, обычный пользователь или всего лишь тот, кто терпеть не может опечаток.
С деталями о содержании и стиле документации Kubernetes вы можете ознакомиться в Documentation style overview.
Типы участников документации
- Член организации Kubernetes, который подписал CLA и уже поработал в проекте определённое время. Перейдите на страницу Членство в сообществе, чтобы узнать что нужно для вступления в организацию.
- Рецензент документации SIG — член организации Kubernetes, который занимался проверкой пулреквестов в документацию и поэтому был добавлен в соответствующую группу на GitHub, и кроме того является ответственным за файлы, перечисленные в
OWNERSв репозитории GitHub. - Утверждающий документации SIG — участник с хорошей репутацией, который продемонстрировал неизменную приверженность проекту. Утверждающий может принимать пулреквесты и публиковать контент от имени организации Kubernetes. Утверждающие также могут быть представителями документации SIG в более крупном сообществе Kubernetes. Некоторые из обязанностей утверждающего документации SIG, такие как организация нового выпуска, требуют огромного количество времени.
Способы участия в документации
Этот список разделен на то, что может делать каждый, что могут делать члены организации Kubernetes, и то, что требует более высокого уровня доступа и знания процессов документации SIG. Со временем постоянное участие в проекте поможет вам понять некоторые средства и организационные решения, которые уже были приняты.
Это не полный список способов поучаствовать в документации Kubernetes, зато он должен помочь вам начать работу.
- Любой человек
- Добавление реализуемых задач
- Член
- Улучшение существующей документации
- Предложение идей по улучшению документации в Slack или в списке рассылки документации SIG
- Улучшение доступности документации
- Составление рекомендаций к пулреквестам в документацию
- Написание постов в блоге или примеров использования продукта
- Рецензент
- Документирование новых функциональных возможностей
- Сортировка и маркировка задач
- Анализ пулреквестов
- Создание диаграмм, графических ресурсов и встраиваемых скринкастов и/или видео
- Локализация
- Участие в других репозиториях в качестве представителя документации
- Редактирование пользовательских строк в коде
- Улучшение комментариев в коде, Godoc
- Утверждающий
- Публикация материалов участников, проверяя и объединяя пулреквесты
- Участие в команде по выпуску новых версий Kubernetes в качестве представителя документации
- Внесение предложений по улучшению руководства по стилю оформлению
- Внесение предложений по улучшению в тесты документации
- Внесение предложений по улучшению в сайт Kubernetes website или другие инструменты
Дополнительные способы участия
- Чтобы помочь сообществу Kubernetes с помощью онлайн-форумов, таких как Twitter или Stack Overflow, либо узнать о местных встречах и мероприятиях по Kubernetes, посетите страницу сообщества Kubernetes.
- Чтобы поучаствовать в разработке функциональности, ознакомьтесь со шпаргалкой для участника, чтобы начать.