advanced_guide_edited
Ilya Z
parent
b33b54b447
commit
9f0afaf0c3
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Участие для опытных
|
||||
title: Существенный вклад
|
||||
slug: advanced
|
||||
content_type: concept
|
||||
weight: 30
|
||||
|
|
@ -22,20 +22,20 @@ weight: 30
|
|||
- Ежедневно проверять [открытые пулреквесты](https://github.com/kubernetes/website/pulls) для контроля качества и соблюдения рекомендаций по [оформлению](/docs/contribute/style/style-guide/) и [содержимому](/docs/contribute/style/content-guide/).
|
||||
- В первую очередь просматривайте самые маленькие пулреквесты (`size/XS`), и только потом беритесь за самые большие (`size/XXL`).
|
||||
- Проверяйте столько пулреквестов, сколько сможете.
|
||||
- Проследить, что CLA подписан каждым участником.
|
||||
- Проследите, что CLA подписан каждым участником.
|
||||
- Помогайте новым участникам подписать [CLA](https://github.com/kubernetes/community/blob/master/CLA.md).
|
||||
- Используйте [этот](https://github.com/zparnold/k8s-docs-pr-botherer) скрипт, чтобы автоматически напомнить участникам, не подписавшим CLA, чтобы они подписали CLA.
|
||||
- Используйте [этот](https://github.com/zparnold/k8s-docs-pr-botherer) скрипт, чтобы автоматически напомнить участникам, не подписавшим CLA, подписать его.
|
||||
- Оставить свое мнение о предложенных изменениях и поспособствовать в проведении технического обзора от членов других SIG-групп.
|
||||
- Предложить исправления для измененного контента в PR.
|
||||
- Если вы хотите убедиться в правильности контента, прокомментируйте PR и задайте уточняющие вопросы.
|
||||
- Добавьте нужны метки с `sig/`.
|
||||
- Если нужно, то назначьте рецензентов из секции `reviewers:` в фронтальной части файла.
|
||||
- Добавьте нужные метки с `sig/`.
|
||||
- Если нужно, то назначьте рецензентов из секции `reviewers:` в верхней части файла.
|
||||
- Добавьте метки `Docs Review` и `Tech Review` для установки статуса проверки PR.
|
||||
- Добавьте метку `Needs Doc Review` или `Needs Tech Review` для пулреквестов, которые ещё не были проверены.
|
||||
- Добавьте метку `Doc Review: Open Issues` или `Tech Review: Open Issues` для пулреквестов, которые были проверены и требуют дополнительную информацию и выполнение действия перед слиянием.
|
||||
- Добавьте метки `/lgtm` и `/approve` для пулреквестов, которые могут быть приняты.
|
||||
- Объедините пулреквесты, если они готовы, либо закройте те, которые не могут быть приняты.
|
||||
- Ежедневно отсортируйте и пометьте новые заявки. Обратитесь к странице [Участие для опытных](/ru/docs/contribute/intermediate/) для получения информации по использование метаданных SIG Docs.
|
||||
- Ежедневно отсортируйте и пометьте новые заявки. Обратитесь к странице [Участие для опытных](/ru/docs/contribute/intermediate/) для получения информации по использованию метаданных SIG Docs.
|
||||
|
||||
### Полезные ссылки на GitHub для дежурных
|
||||
|
||||
|
|
@ -43,9 +43,9 @@ weight: 30
|
|||
|
||||
- [Нет CLA, нет права на слияние](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+label%3A%22cncf-cla%3A+no%22+-label%3Ado-not-merge+label%3Alanguage%2Fen): напомните участнику подписать CLA. Если об этом уже напомнил и бот, и человек, то закройте PR и напишите автору, что он может открыть свой PR после подписания CLA.
|
||||
**Не проверяйте PR, если их авторы не подписали CLA!**
|
||||
- [Требуется LGTM](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+-label%3Ado-not-merge+label%3Alanguage%2Fen+-label%3Algtm+): если нужен проверка с технической точки зрения, попросите её провести одного из рецензентов, который предложил бот. Если требуется просмотр пулреквест со стороны группы документации или вычитка, то предложите изменения, либо сами измените PR, чтобы ускорить процесс принятия пулреквеста.
|
||||
- [Имеет LGTM, нужно одобрение со стороны группы документации](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+-label%3Ado-not-merge+label%3Alanguage%2Fen+label%3Algtm): выясните, нужно ли внести какие-либо дополнительные изменения или обновления, чтобы принять PR. Если по вашему мнению PR готов к слияния, оставьте комментарий с текстом `/approve`.
|
||||
- [Быстрые результаты](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Amaster+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3A%22cncf-cla%3A+yes%22+label%3A%22size%2FXS%22+label%3A%22language%2Fen%22+): если маленький PR направлен в основную ветку и не имеет условий для объединения. (поменяйте "XS" в метке с размером при работе с другими пулреквестами [XS, S, M, L, XL, XXL]).
|
||||
- [Требуется LGTM](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+-label%3Ado-not-merge+label%3Alanguage%2Fen+-label%3Algtm+): если нужна проверка с технической точки зрения, попросите её провести одного из рецензентов, которого предложил бот. Если требуется просмотр пулреквеста со стороны группы документации или вычитка, то предложите изменения, либо сами измените PR, чтобы ускорить процесс принятия пулреквеста.
|
||||
- [Имеет LGTM, нужно одобрение со стороны группы документации](https://github.com/kubernetes/website/pulls?q=is%3Aopen+is%3Apr+-label%3Ado-not-merge+label%3Alanguage%2Fen+label%3Algtm): выясните, нужно ли внести какие-либо дополнительные изменения или обновления, чтобы принять PR. Если по вашему мнению PR готов к слиянию, оставьте комментарий с текстом `/approve`.
|
||||
- [Быстрые результаты](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Amaster+-label%3A%22do-not-merge%2Fwork-in-progress%22+-label%3A%22do-not-merge%2Fhold%22+label%3A%22cncf-cla%3A+yes%22+label%3A%22size%2FXS%22+label%3A%22language%2Fen%22+): если маленький PR направлен в основную ветку и не имеет условий для объединения (поменяйте "XS" в метке с размером при работе с другими пулреквестами [XS, S, M, L, XL, XXL]).
|
||||
- [Вне основной ветки](https://github.com/kubernetes/website/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+-label%3Ado-not-merge+label%3Alanguage%2Fen+-base%3Amaster): если PR отправлен в ветку `dev-`, значит он предназначается для будущего выпуска. Убедитесь, что [release meister](https://github.com/kubernetes/sig-release/tree/master/release-team) знает об этом, добавив комментарий с `/assign @<meister's_github-username>`. Если он направлен в старую ветку, помогите автору PR изменить на более подходящую ветку.
|
||||
|
||||
### Когда закрывать пулреквесты
|
||||
|
|
@ -57,7 +57,7 @@ weight: 30
|
|||
|
||||
- Закройте любой PR, если автор не отреагировал на комментарии или проверки в течение 2 или более недель.
|
||||
|
||||
Не бойтесь закрывать пулреквесты. Участники с лёгкостью открыть и возобновить незаконченную работу. Зачастую уведомление о закрытии стимулировать автора возобновить и закончить свой вклад.
|
||||
Не бойтесь закрывать пулреквесты. Участники с лёгкостью могут открыть и возобновить незаконченную работу. Зачастую уведомление о закрытии стимулирует автора возобновить и завершить свою работу до конца.
|
||||
|
||||
Чтобы закрыть пулреквест, оставьте комментарий `/close` в PR.
|
||||
|
||||
|
|
@ -71,8 +71,8 @@ weight: 30
|
|||
|
||||
[Члены](/ru/docs/contribute/participating/#члены) SIG Docs могут предлагать улучшения.
|
||||
|
||||
После того, как вы давно начали работать над документацией Kubernetes, у наверняка появились какие-нибудь идеи по улучшению [руководства по оформлению](/docs/contribute/style/style-guide/), [руководства по оформлению](/docs/contribute/style/content-guide/), набору инструментов, который используется для создания документации, стилизации сайта, процессов проверки и объединения пулреквестов. Для максимальной открытости подобные типы предложений по улучшению должны обсуждаться на встречи SIG Docs или в [списке рассылки kubernetes-sig-docs](https://groups.google.com/forum/#!forum/kubernetes-sig-docs).
|
||||
Помимо этого, это поможет разъяснить, как всё устроено в данный момент, и объяснить, почему так было принято, прежде чем предлагать радикальные изменения. Самый быстрый способ узнать ответы на вопросы о том, как в настоящее время работает документация, это задать их на канале `#sig-docs` Slack на [kubernetes.slack.com](https://kubernetes.slack.com).
|
||||
Если вы давно начали работать над документацией Kubernetes, у вас наверняка появились какие-нибудь идеи по улучшению [руководства по оформлению](/docs/contribute/style/style-guide/), [руководства по содержанию](/docs/contribute/style/content-guide/), набору инструментов, который используется для создания документации, стилизации сайта, процессов проверки и объединения пулреквестов. Для максимальной открытости подобные типы предложений по улучшению должны обсуждаться на встречи SIG Docs или в [списке рассылки kubernetes-sig-docs](https://groups.google.com/forum/#!forum/kubernetes-sig-docs).
|
||||
Помимо этого, это поможет разъяснить, как всё устроено в данный момент, и объяснить, почему так было принято, прежде чем предлагать радикальные изменения. Самый быстрый способ узнать ответы на вопросы о том, как в настоящее время работает документация, это задать их в канале `#sig-docs` в [официальном Slack](https://kubernetes.slack.com).
|
||||
|
||||
Когда обсуждение состоялось, а SIG-группа согласилась с желаемым результатом, вы можете работать над предлагаемыми изменениями наиболее приемлемым способом. Например, обновление руководства по оформлению или функциональности сайта может включать открытие пулреквеста, а изменение, связанное с тестированием документации, может предполагать взаимодействие с sig-testing.
|
||||
|
||||
|
|
@ -84,11 +84,11 @@ weight: 30
|
|||
|
||||
Представитель SIG Docs для данного выпуска координирует следующие задачи:
|
||||
|
||||
- Мониторинг электронной таблицы с отслеживанием функциональности на наличие новых или измененных возможностей, затрагивают документацию. Если документация для определенной функциональности не будет готова к выпуску, возможно, она не попадет в выпуск.
|
||||
- Регулярное посещение встречи sig-release и обновлять информацию о статусе документации в выпуске.
|
||||
- Мониторинг электронной таблицы с отслеживанием функциональности на наличие новых или измененных возможностей, затрагивающих документацию. Если документация для определенной функциональности не будет готова к выпуску, возможно, она не попадет в выпуск.
|
||||
- Регулярное посещение встречи sig-release и обновление информации о статусе документации к выпуску.
|
||||
- Проверка и вычитка документации по функциональности, подготовленной SIG-группой, ответственной за реализацию этой функциональности.
|
||||
- Объединение связанных с выпуском пулреквестов и поддержка Git-ветки выпуска.
|
||||
- Консультируйте других участников SIG Docs, которые хотят научиться выполнять эту роль в будущем. Это называется сопровождение (shadowing).
|
||||
- Консультирование других участников SIG Docs, которые хотят научиться выполнять эту роль в будущем. Это называется сопровождение (shadowing).
|
||||
- Публикация изменений в документации, связанные с выпуском при размещении артефактов.
|
||||
|
||||
Координация выпуска обычно занимает 3-4 месяца, а обязанности распределяются между утверждающими SIG Docs.
|
||||
|
|
@ -101,10 +101,10 @@ weight: 30
|
|||
|
||||
Обязанности амбассадоров новых участников включают в себя:
|
||||
|
||||
- Отвечать на вопросы новых участников на [Slack-канале Kubernetes #sig-docs](https://kubernetes.slack.com).
|
||||
- Отвечать на вопросы новых участников в [Slack-канале Kubernetes #sig-docs](https://kubernetes.slack.com).
|
||||
- Совместно работать с дежурным по PR, чтобы определять заявки, которые подойдут для решения новыми участниками.
|
||||
- Консультировать новых участников в их PR.
|
||||
- Помогать новых участникам в создании более сложных PR, чтобы они могли стать членами Kubernetes.
|
||||
- Помогать новым участникам в создании более сложных PR, чтобы они могли стать членами Kubernetes.
|
||||
- [Оказывать содействие участникам](/ru/docs/contribute/advanced/#поддержка-нового-участника) на их пути становления членом в Kubernetes.
|
||||
|
||||
Текущие амбассадоры новых участников объявляются на каждом собрании SIG Docs и на канале [#sig-docs в Kubernetes](https://kubernetes.slack.com).
|
||||
|
|
@ -115,7 +115,7 @@ weight: 30
|
|||
|
||||
Если участник сделал 5 значительных пулреквестов в один или несколько репозиториев Kubernetes, он имеет право на [членство](/ru/docs/contribute/participating#члены) в организации Kubernetes. Членство участника должно быть поддержано двумя спонсорами, которые уже являются рецензентами.
|
||||
|
||||
Новые участники документации могут найти спонсоров в канале #sig-docs в [в Slack Kubernetes](https://kubernetes.slack.com) или в [списке рассылки SIG Docs](https://groups.google.com/forum/#!forum/kubernetes-sig-docs). Если вы осознали полезность работы автора заявки на членство, вы добровольно можете поддержать (спонсировать) его. Когда они подадут заявку на членство, отреагируйте на заявку "+1" и напишите подробный комментарий о том, почему вы считаете, что кандидат отлично вписывается в члены организации Kubernetes.
|
||||
Новые участники документации могут найти спонсоров в канале #sig-docs [в Slack Kubernetes](https://kubernetes.slack.com) или в [списке рассылки SIG Docs](https://groups.google.com/forum/#!forum/kubernetes-sig-docs). Если вы осознали полезность работы автора заявки на членство, вы добровольно можете поддержать (спонсировать) его. Когда они подадут заявку на членство, отреагируйте на заявку "+1" и напишите подробный комментарий о том, почему вы считаете, что кандидат отлично вписывается в члены организации Kubernetes.
|
||||
|
||||
## Сопредседатель SIG
|
||||
|
||||
|
|
@ -125,9 +125,9 @@ weight: 30
|
|||
|
||||
Сопредседатели должны соответствовать следующим требованиям:
|
||||
|
||||
- Быть утверждающим SIG Docs не меньше 6 месяцев
|
||||
- [Руководить выпуском документации Kubernetes](/docs/contribute/advanced/#coordinate-docs-for-a-kubernetes-release) или сопровождать два выпуска
|
||||
- Понимание рабочих процессов и инструментов SIG Docs: git, Hugo, локализация, блог
|
||||
- Быть утверждающими SIG Docs не меньше 6 месяцев.
|
||||
- [Руководить выпуском документации Kubernetes](/docs/contribute/advanced/#coordinate-docs-for-a-kubernetes-release) или сопроводить два выпуска.
|
||||
- Понимать рабочие процессы и инструменты SIG Docs: git, Hugo, локализация, блог.
|
||||
- Понимать, как другие SIG-группы и репозитории Kubernetes влияют на рабочий процесс SIG Docs, включая: [команды в k/org](https://github.com/kubernetes/org/blob/master/config/kubernetes/sig-docs/teams.yaml), [процессы в k/community](https://github.com/kubernetes/community/tree/master/sig-docs), плагины в [k/test-infra](https://github.com/kubernetes/test-infra/) и роль [SIG Architecture](https://github.com/kubernetes/community/tree/master/sig-architecture).
|
||||
- Уделять не менее 5 часов в неделю (но зачастую больше) в течение как минимум 6 месяцев для выполнения обязанностей.
|
||||
|
||||
|
|
@ -137,13 +137,13 @@ weight: 30
|
|||
|
||||
Обязанности включают в себя:
|
||||
|
||||
- Сосредоточить группу SIG Docs на достижении максимального счастья для разработчиков через отличную документацию
|
||||
- Быть примером соблюдения [норм поведения сообщества]https://github.com/cncf/foundation/blob/master/code-of-conduct.md) и контролировать их выполнение членами SIG
|
||||
- Изучение и внедрение передовых практик для SIG-группы, обновляя рекомендации по участию
|
||||
- Планирование и проведение встреч SIG: еженедельные обновления информации, ежеквартальные ретроспективные/плановые совещания и многое другое
|
||||
- Планирование и проведение спринтов по документации на мероприятиях KubeCon и других конференциях
|
||||
- Сосредоточить группу SIG Docs на достижении максимального счастья для разработчиков через отличную документацию.
|
||||
- Быть примером соблюдения [норм поведения сообщества](https://github.com/cncf/foundation/blob/master/code-of-conduct.md) и контролировать их выполнение членами SIG.
|
||||
- Изучать и внедрять передовые практики для SIG-группы, обновляя рекомендации по участию.
|
||||
- Планировать и проверять встречи SIG: еженедельные обновления информации, ежеквартальные ретроспективные/плановые совещания и многое другое.
|
||||
- Планирование и проведение спринтов по документации на мероприятиях KubeCon и других конференциях.
|
||||
- Набирать персонал и выступать в поддержку {{< glossary_tooltip text="CNCF" term_id="cncf" >}} и его платиновых партнеров, включая Google, Oracle, Azure, IBM и Huawei.
|
||||
- Поддерживать нормальную работу SIG
|
||||
- Поддерживать нормальную работу SIG.
|
||||
|
||||
### Проведение продуктивных встреч
|
||||
|
||||
|
|
@ -155,33 +155,33 @@ weight: 30
|
|||
|
||||
**Сформулируйте четкую повестку дня**:
|
||||
|
||||
- Определите конкретную цель встречи
|
||||
- Опубликуйте программу дня заранее
|
||||
- Определите конкретную цель встречи.
|
||||
- Опубликуйте программу дня заранее.
|
||||
|
||||
Для еженедельных встреч скопируйте примечания из предыдущей недели в раздел "Past meetings".
|
||||
|
||||
**Работайте вместе для создания точных примечания**:
|
||||
|
||||
- Запишите обсуждение встречи
|
||||
- Подумайте над тем, чтобы делегировать роль стенографист кому-нибудь другому
|
||||
- Запишите обсуждение встречи.
|
||||
- Подумайте над тем, чтобы делегировать роль стенографиста кому-нибудь другому.
|
||||
|
||||
**Определяйте решения по пунктам повестки четко и точно**:
|
||||
|
||||
- Записывайте решения по пунктам, кто будет ими заниматься и ожидаемую дату завершения
|
||||
- Записывайте решения по пунктам, кто будет ими заниматься и ожидаемую дату завершения.
|
||||
|
||||
**Руководите обсуждением, когда это необходимо**:
|
||||
|
||||
- Если обсуждение выходит за пределы повестки дня, снова обратите внимание участников на обсуждаемую тему
|
||||
- Найдите место для различных стилей ведения обсуждения, не отвлекаясь от темы обсуждения и уважая время людей
|
||||
- Если обсуждение выходит за пределы повестки дня, снова обратите внимание участников на обсуждаемую тему.
|
||||
- Найдите место для различных стилей ведения обсуждения, не отвлекаясь от темы обсуждения и уважая время людей.
|
||||
|
||||
**Уважайте время людей**:
|
||||
|
||||
- Начинайте и заканчивайте встречи своевременно
|
||||
- Начинайте и заканчивайте встречи своевременно.
|
||||
|
||||
**Используйте Zoom эффективно**:
|
||||
|
||||
- Ознакомьтесь с [рекомендациями Zoom для Kubernetes](https://github.com/kubernetes/community/blob/master/communication/zoom-guidelines.md)
|
||||
- Попробуйте попроситься быть ведущим в самом начале встречи, введя ключ ведущего
|
||||
- Ознакомьтесь с [рекомендациями Zoom для Kubernetes](https://github.com/kubernetes/community/blob/master/communication/zoom-guidelines.md).
|
||||
- Попробуйте попроситься быть ведущим в самом начале встречи, введя ключ ведущего.
|
||||
|
||||
<img src="/images/docs/contribute/claim-host.png" width="75%" alt="Исполнение роли ведущего в Zoom" />
|
||||
|
||||
|
|
@ -192,5 +192,3 @@ weight: 30
|
|||
Если нужно остановить запись, нажмите на кнопку Stop.
|
||||
|
||||
Запись автоматически загрузится на YouTube.
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue