Проект Фонда Linux

На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.

Краткое описание проекта

Организация с открытым исходным кодом:
Фонд Linux
Технический писатель:
Джаскиратсингх2000
Название проекта:
ХАОСС: создайте справочник для всего сообщества ХАОСС
Длина проекта:
Стандартная продолжительность (3 месяца)

Описание Проекта

АННОТАЦИЯ ПРОЕКТА:

В настоящее время рабочие группы внутри сообщества CHAOSS разработали свои собственные способы работы и в разной степени документировали свои разрозненные процессы. Рабочие группы включают в себя рабочую группу по общим показателям, рабочую группу по разнообразию и инклюзивности, рабочие группы по эволюции, рискам и ценностям, которые установили свои собственные способы участия и работы и адаптировали различные способы общения и рабочую культуру. Эти рабочие группы в соответствии с показателями имеют разные области деятельности и опыт, который подходит для соответствующих показателей, ведут различные исследования и разработки в рамках соответствующей категории рабочих групп и знают правильный путь для проведения различных исследований и разработок в соответствующих категориях, но процессы для новичков и существующих участников. может быть неизвестно, как принять участие или выбрать правильный путь для соответствующих работ.

В результате все в сообществе CHAOSS не стандартизировано. Поэтому, чтобы знать правильный процесс и основные основы рабочей культуры в сообществе, цель руководства сообщества — централизовать важную информацию и стандартизировать ее части в рамках проекта CHAOSS. Части критической информации и стандартизации в основном сосредоточены на процессах, которые использует CHAOSS, чтобы у CHAOSS было согласие относительно того, как сообщество выполняет работу, как новички могут участвовать и следовать основам сообщества, а также каким процессам и путям должны следовать новички или существующие участники для достижения цели. используя лидерство в сообществе CHAOSS.

Руководство должно служить инструкцией для существующих и новых членов сообщества о том, как выполнять работу в проекте CHAOSS. Этот проект включает творческий компонент по сбору и организации содержания справочника, а также технический компонент по определению того, как представлять справочник.

КАКАЯ В ЭТОМ НЕОБХОДИМОСТЬ?

Справочник сообщества — это документ, который определяет ключевые политики и процедуры сообщества, а также описывает миссию, ценности и работу сообщества.

Это руководство обеспечивает четкое введение и работу для вновь присоединившихся членов сообщества. В настоящее время Справочник сообщества CHAOSS доступен в репозитории GitHub и нуждается в обновлении и рефакторинге, включив в него больше информации для новичков и существующих пользователей сообщества. Таким образом, это руководство для всего сообщества CHAOSS поможет новичкам и существующим членам сообщества следующими способами:

  • Формализация и организация политик сообщества CHAOSS, размещение их всех в одном месте.
  • Распространение информации о введении, миссии, видении и лидерстве сообщества.
  • Понимание практик сообщества CHAOSS
  • Рекомендации по внесению взносов
  • Определение рабочих процессов проекта
  • Краткое описание культуры сообщества CHAOSS
  • Общие часто задаваемые вопросы
  • Наставничество

ОПИСАНИЕ ПРОЕКТА:

Справочник сообщества будет разделен на различные «разделы», которые будут содержать соответствующую и подробную информацию по конкретным темам. Разделы можно разделить следующим образом:

  • Введение
  • Путь сообщества CHAOSS
  • Путь к лидерству
  • Терминология
  • Рекомендации по внесению взносов
    • Разработчик
    • Дизайнер
    • Писатель
    • Маркетолог
  • Метрики
  • ХАОССкон
  • ХАОСКаст
  • Видео встреч
  • Общие часто задаваемые вопросы
  • Наставничество
    • Google Лето кода
    • Информационно-пропагандистская деятельность
    • Google Сезон Документов

ПОДРОБНЫЕ РЕЗУЛЬТАТЫ ПРОЕКТА

1. Введение:

Этот раздел станет первой страницей справочника сообщества CHAOSS и будет содержать подробную информацию, обзор и использование справочника. Ниже приведены следующие вещи:

A.) Оно будет содержать приветственное сообщение с кратким описанием сообщества CHAOSS, которое поможет убедить читателей ознакомиться с Руководством. Я также включу коллаж изображений, взятый отсюда https://chaoss.community/chaoss-photo-album/, который подчеркнет различные движения внутри сообщества. Б.) Страница также будет содержать подробную информацию обо всех разделах с однострочным описанием, объясняющим каждый раздел, и соответствующими ссылками. C.) Использование справочника: Использование справочника уже существует здесь ( shorturl.at/cqQU6 ), но я обновлю и реорганизую существующее использование справочника с улучшенной уценкой, которая будет включать в себя поток справочника (я включу, как все происходит, когда кто-то хочет добавлять, удалять или обсуждать информацию, связанную с руководством. Он может отслеживать процесс обмена информацией по любым вопросам, связанным с руководством.), Рекомендации по руководству (которые включают его использование в сообществе и сферу применения), Вклад в руководство (которое включает в себя как следует использовать репозиторий для внесения изменений, создания PR, шаблона для внесения изменений в Руководство и Руководство по стилю), а также обмена отзывами о Руководстве. В раздел «Обмен отзывами» я включу шаблон и различные способы, с помощью которых пользователи смогут отправлять или использовать проблемы GitLab для его получения.

2.) Путь сообщества CHAOSS:

Путь сообщества CHAOSS будет важен для того, чтобы люди понимали практику и рекомендации сообщества. Рабочие процессы смогут сделать это более акцентированным и наилучшим образом изложить практики сообщества. В этот раздел входят следующие вещи:

А.) Общие ценности: описание того, как в сообществе CHAOSS реализуются вопросы устойчивого развития, открытости и прозрачности. Я объясню эти ценности, как новые пользователи или существующие пользователи должны их понимать и учитывать при работе с сообществом. Б.) Правила сообщества: сюда входит то, как на самом деле следует участвовать в сообществе CHAOSS и соблюдать основные условия. Это также объясняет культуру труда, которой придерживаются внутри сообщества. (что можно и чего нельзя). Он будет включать в себя контрольный список основных участников/сопровождающих, а также позволит им узнать, как им следует работать с сопровождающими и каков их контрольный список. C.) Рабочие группы: эта страница ( https://chaoss.community/participate/ ) содержит информацию о рабочих группах, такую ​​​​как описание рабочей группы, ссылку на репо и информацию о собрании, но в справочник я включу информацию о том, как участвовать в различные рабочие группы и понимать процесс оценки показателей, понимать культуру работы соответствующей рабочей группы и то, как стать основным участником различных рабочих групп.

3.) Путь к лидерству:

Хотя достижение лидерства в проекте с открытым исходным кодом может иметь жизненно важное значение для собственного успеха сообщества в коммерческом мире. Итак, принимая это во внимание, я включу следующее:

A.) Техническое руководство: сюда будут включены процессы и обязанности специалистов по сопровождению репо, составителей документации и сопровождающих веб-сайтов. B.) Лидерство в области управления: сюда будут включены пути для члена Совета директоров и лица, принимающего решения. C.) Операционное лидерство: оно будет содержать путь для комьюнити-менеджеров

4.) Терминология:

Терминология поможет описать термины и соответствующие принадлежности, которые часто используются в сообществе CHAOSS. Кроме того, я также включу рекомендации по использованию терминологии, такие как использование заглавных букв, сокращений и слов, которых следует избегать, с указанием причин. Условия, которые будут включены: Проект CHAOSS, Здоровье сообщества с открытым исходным кодом, Проверка кода, Рабочая группа, Метрика программного обеспечения с открытым исходным кодом, Общая метрика, Метрика разнообразия и инклюзивности, Рабочая группа по развитию, Рабочая группа по рискам, Рабочая группа по ценности, Выпуск метрики, Зона фокусировки.

5.) Рекомендации по внесению взносов:

Это основной контекст для любого сообщества открытого исходного кода, поскольку большая часть сообщества открытого исходного кода зависит от вкладов или волонтерской работы, поэтому это поможет любому новичку/пользователю, присоединяющемуся к сообществу, понять основные необходимости и рекомендации, которым они должны следовать. Итак, это будет включать в себя следующие детали:

A.) Понимание дорожной карты сообщества. Эта тема приведет к обзору дорожной карты сообщества CHAOSS, которая поможет пользователям узнать, каким путем или процессом следовать, определяя приоритеты различных работ в рамках проекта CHAOSS. Б.) Объяснение всего необходимого для практического участия в разработке, документации, проектировании, тестировании и т. д. В.) Краткий обзор работы GitLab Г.) Руководство для рецензентов/сопровождающих

Этот раздел также будет содержать «Роли и обязанности» для каждой категории вклада, которые приведены ниже:

а.) ДИЗАЙН: Этот подраздел будет включать «Рабочий процесс проектирования ХАОСС» и Рекомендации по проектированию, которые будут содержать принципы проектирования, процессы и используемые инструменты, которым участники должны следовать, внося свой вклад в область дизайна. б.) РАЗРАБОТКА: Здесь будет содержаться руководство по вкладу в кодовую базу. Он будет содержать технические требования, структуру проекта, настройку проекта (Augur, Cregit, GremoireLab). c.) ДОКУМЕНТАЦИЯ: Сюда будут включены ресурсы для документации, включая инструменты и руководство по стилю. d.) РАЗВИТИЕ: Это будет включать в себя то, как участники могут поддержать сообщество CHAOSS в расширении охвата - написание блогов, использование социальных сетей, организация встреч и мероприятий.

6.) Метрики

В настоящее время веб-сайт сообщества CHAOSS содержит информацию о выпусках метрик ( https://chaoss.community/metrics/ ), и для людей более важно понимать, как следовать процессу, чтобы сделать свой веб-сайт метрик доступным на этом веб-сайте. Таким образом, в этом разделе будет представлена ​​информация, которая поможет пользователям узнать процессы и работу, чтобы иметь собственный выпуск метрик.

7.) ХАОССкон:

Информация о CHAOSScon уже существует на GitHub ( https://github.com/chaoss/governance/blob/master/community-handbook/chaosscon.md ) и на веб-сайте ( https://chaoss.community/CHAOSScon-2020-NA/ ), но имеет смысл добавить в Руководство детали и информацию, объясняющую процессы и способы управления CHAOSScon. В справочнике будет содержаться следующая информация:

A.) Подробная информация об организационном комитете: в нем будут объяснены процессы участия в организационном комитете CHAOSScon. B.) Управление процессом подачи заявок: это будет включать в себя управление регистрацией авторов, подачу предложений и документации, рассмотрение и утверждение. процесс. C.) Управление и публикация программы CHAOSScon D.) Как управлять рекламой и маркетингом E.) Как обрабатывать спонсорские предложения и средства, включая пакеты

8.) ХАОСКаст:

Информация о CHAOSScast доступна здесь https://github.com/chaoss/governance/blob/master/community-handbook/chaosscast.md и будет включена в Справочник с некоторыми дополнительными сведениями, такими как участие, организационный комитет, реклама и маркетинговые материалы.

9.) Видео встреч:

Он будет содержать все видеосовещания с описанием, например «Участники», «Повестка дня» и т. д., которые проводились в прошлом и доступны на Youtube.

10.) Общие часто задаваемые вопросы:

Они будут содержать общие вопросы, которые задают в сообществе, и это поможет новичкам и существующим членам сообщества ответить на некоторые из них.

11.) Google Summer of Code:

Этот раздел будет содержать информацию о Google Summer of Code, критериях отбора, а также информацию о том, как люди могут участвовать в сообществе CHAOSS в Google Summer of Code. Этот раздел также будет содержать шаблон предложения, который люди смогут использовать для составления своего предложения, а также ролей и обязанностей. Более того, он также будет содержать информацию, которая поможет существующим членам сообщества изучить процесс становления администратором организации и наставниками.

  1. Информационно-просветительская деятельность:

Этот раздел будет содержать информацию о Outreachy, критериях отбора и информацию о том, как люди могут участвовать в сообществе CHAOSS в Outreachy. Здесь будут описаны роли и обязанности, включая процесс становления администратором организации и наставниками.

  1. Google Сезон Документов:

Этот раздел будет содержать информацию о GSoD, критериях отбора, а также информацию о том, как люди могут участвовать в сообществе CHAOSS в GSoD. Он будет содержать роли и обязанности, включая процесс становления администратором организации и наставниками.

ОЖИДАЕМЫЙ РЕЗУЛЬТАТ ПРОЕКТА:

Справочники играют важную роль в любом сообществе. Аналогичным образом, это руководство для всего сообщества CHAOSS приведет к созданию более организованной и подробной документации для сообщества CHAOSS. Любому новичку, присоединившемуся к сообществу, а также существующим членам сообщества станет легко понять основы и работу сообщества CHAOSS. Более того, благодаря этому справочнику в сообществе CHAOSS будут представлены различные процессы и пути к разным культурам труда.

ТЕХНИЧЕСКИЕ ДЕТАЛИ:

Я предлагаю использовать платформу Gitbook для поддержки руководства, поскольку это удобный для пользователя проект для совместной работы, позволяющий командам работать более эффективно и результативно. Некоторые особенности платформы GitBook:

  • WYSIWYG: мощный и в то же время красивый текстовый редактор.
  • Markdown: мощная и продуктивная поддержка ярлыков уценок.
  • Богатое внедрение: встраивает внешний веб-контент, такой как видео, фрагменты кода, статьи, музыку и многое другое.
  • Панели для писателей: создайте интеллектуальную панель для писателей, поддерживающую визуальное редактирование.
  • Черновики: проектируйте новые изменения и работайте асинхронно.
  • Комментарии службы поддержки: обсуждение и просмотр проектов изменений.
  • Отслеживайте историю написания: отслеживайте все. Просмотр и отмена изменений
  • Статистика: он также поддерживает аналитику, которая отслеживает трафик, рейтинг и качество контента.
  • GitHub Sync: сохранение рабочего процесса и постоянная синхронизация документов с GitHub.
  • Персонализация брендинга: пользовательские домены, собственные логотипы, шрифты, цвета, темы, заголовок и т. д.

Вот несколько изображений, которые дают представление о платформе

  • shorturl.at/GNQR4
  • shorturl.at/gATZ8
  • shorturl.at/qrE57
  • shorturl.at/rFRX6
  • shorturl.at/eyLW1
  • shorturl.at/rwHS8

-- Где будет храниться Справочник?

Справочник будет размещен на самом GitBook, где GitHub предоставляет надлежащий механизм для пользовательского домена, общих ошибок и SEO.

Пользовательские домены: если сообщество CHAOSS захочет разместить его в личном домене, он будет отображаться следующим образом: docs.chaoss.community. Организации необходимо просто создать любой поддомен, который она пожелает. Чтобы настроить домен организации, перейдите в настройки организации на платформе Gitbook. Пример изображения: shorturl.at/GNQR4

Пространства GitBook обслуживаются через нашу собственную CDN с включенным по умолчанию протоколом HTTPS. Сертификаты выданы LetsEncrypt.

Поддерживаемые домены:

  • Поддомен: www.example.com
  • Пользовательский домен: docs.example.com.

-- Как синхронизировать Gitbook с GitHub, чтобы эффективно выполнять редактирование на обеих платформах?

Интеграция с GitHub очень проста в использовании: если кто-то меняет какой-либо контент в GitBook, его изменения передаются в репозиторий GitHub. И наоборот, коммиты, отправленные в репозиторий GitHub, импортируются в GitBook.

Настройте интеграцию с GitHub:

  • В своем пространстве на платформе GitBook щелкните вкладку «Интеграции» > GitHub.
  • Разрешите GitBook получить доступ к вашей учетной записи GitHub, связанной с вашей организацией.
  • Перейдите на GitHub своей организации и создайте репозиторий для «HandBook», например. справочник по хаосу
  • Теперь выберите репозиторий с именем chaoss-handbook, который вы хотите подключить с помощью опции авторизации внутри платформы GitBook.

Как только эти шаги будут выполнены, GitBook добавит вебхук в репозиторий chaoss-handbook, который позволит ему получать контент при каждом изменении в репозитории. При внесении изменений в GitBook будет добавлен новый комментарий.

Вот и все! Любой желающий может продолжить редактирование из репозитория GitBook или GitHub.

-- Как редактировать страницы на платформе GitBook?

Любой, кто хочет редактировать что-либо на платформе GitBook, должен присоединиться к платформе GitBook с помощью приглашения или ссылки для присоединения. GitBook поддерживает визуальное редактирование, при котором пользователи могут писать прямо на страницах.

Черновик — это редактируемая версия пользовательского контента, доступная только авторам и создаваемая автоматически, как только вы начинаете писать (первое письмо в редакторе, создание новой страницы, загрузка изображения и т. д.).

Изменения, внесенные в черновик, относятся к нему, что позволяет пользователям вносить свой вклад в один и тот же документ с другими участниками одновременно, не создавая никаких конфликтов! Это то, что мы называем асинхронным редактированием и разрешением конфликтов.

Первая версия черновика не всегда готова к немедленной публикации. Используйте «сохранить», если вы хотите продолжить работу позже или если ваш контент еще не готов к «объединению».

Когда вы закончите редактирование, вы можете «объединить» свой черновик. Написанный вами контент или внесенные вами изменения будут доступны членам вашей команды и/или станут общедоступными.

Примеры изображений: shorturl.at/gATZ8 и shorturl.at/qrE57.

-- Структура контента:

Оглавление: каждое пространство может содержать столько страниц, сколько вам нужно для написания документации. Все эти страницы отображаются в левой части экрана в так называемой таблице содержания. Из таблицы содержания вы можете управлять своими страницами: создавать новые страницы, группы страниц, добавлять внешние ссылки, добавлять вариант, импортировать внешние документы, такие как веб-сайты или файлы в формате Markdown (.md или .markdown), HTML (.html). , Microsoft Word (.docx).

Начальная страница: Начальная страница является домашней страницей или корнем вашей документации и по сути работает как мастер всех страниц вашей документации. Поскольку это главный вход в вашу документацию и в ваше пространство, эту страницу нельзя перемещать, удалять, иметь детей или находиться в группе.

Страницы: страница имеет заголовок и необязательное описание в верхней части редактора. Затем вы можете писать и добавлять в него любой контент.‌ Вы можете вкладывать страницы, перетаскивая одну страницу под другую. Дочерние элементы страницы будут скрыты, но их можно свернуть.

Внешние ссылки: эти записи являются внешними ссылками и не содержат никакого контента в редакторе. Их основная функция — ссылки на внешние веб-сайты.

Варианты. Вы можете создать альтернативный контент для своей документации, создав вариант. Это может быть полезно для документирования нескольких версий API, библиотеки или переводов.

Пример изображения: shorturl.at/eyLW1 и shorturl.at/rFRX6.

-- Как Руководство будет представлено на стороне клиента?

Справочник сообщества Chaoss будет доступен через субдомен, который может быть https://docs.chaoss.community, и на стороне пользователя он будет выглядеть следующим образом:

  • Справочник Mattermost - https://handbook.mattermost.com/
  • Документация по мосту сообщества Linux Foundation — https://docs.linuxfoundation.org/docs/ И многое другое.

СРОКИ РЕАЛИЗАЦИИ ПРОЕКТА:

1.) Фаза объединения сообществ (17 августа – 13 сентября)

А.) Недели 1–4:

  • Обсудить проект с наставниками
  • Изучите и соберите информацию, необходимую для различных разделов проекта, задайте уточняющие вопросы сообществу.
  • Уточните у сообщества, какую платформу использовать для руководства (я предлагаю GitBook) и настройте ее.
  • Помогите решить проблемы с документами

2.) Этап разработки документа (14 сентября – 30 ноября)

А.) Неделя 5 (14–20 сентября)

  • Проект» Вводный раздел

Б.) Неделя 6 (21 сентября – 27 сентября)

  • Проект раздела «Путь сообщества CHAOSS»

C.) Неделя 7 (28 сентября – 4 октября)

  • Проект раздела «Путь к лидерству»
  • Проект раздела «Терминология»

D.) Неделя 8 (5 октября – 11 октября)

  • Проект дорожной карты сообщества
  • Предварительные рекомендации по вкладу в проектирование

E.) Неделя 9 (12 октября – 18 октября)

  • Проект раздела «Разработка»

F.) Неделя 10 (19 октября – 25 октября)

  • Рекомендации по разделу «Письмо и информационно-просветительская деятельность»

G.) Неделя 11 (26 октября – 1 ноября)

  • Проект раздела показателей
  • Проект раздела CHAOSScon

H.) Неделя 12 (2 ноября – 8 ноября)

  • Создайте раздел собрания

  • Черновик общих часто задаваемых вопросов сообщества

    I.) Неделя 13 (9 ноября – 15 ноября)

  • Проект рекомендаций GSoC

J.) Неделя 14 (16–22 ноября)

  • Проект руководящих принципов информационно-пропагандистской деятельности

К.) Неделя 15 (23–29 ноября)

  • Буферное время; Полировка и улучшение всей документации

3.) Этап оценки (30 ноября – 5 декабря)

А.) Неделя 16:

  • Составить отчет по проекту
  • Заполните оценку проекта

ВЗАИМОДЕЙСТВИЕ С СООБЩЕСТВАМИ

1.) Вовлечение и обсуждение с сообществом.

Что ж, я сижу в сообществе CHAOSS с апреля 2020 года и участвовал в различных дискуссиях с членами сообщества и с наставниками моих конкретных проектов (Георгом Линком и Армстронгом Фаунджемом). Одним из таких обсуждений, вызвавшим больший интерес членов сообщества, было «Предложение Gitbook в качестве платформы для размещения Справочника сообщества». Его можно найти в ветке списка рассылки архива CHAOSS с названием «Предложение Gitbook в качестве платформы для размещения Справочника сообщества». Я также участвовал в еженедельных телеконференциях сообщества, которые помогали мне сообщать сообществу обновленную информацию.

2.) Как вы будете собирать информацию, необходимую для этого проекта?

Поскольку этот проект требует создания справочника для всего сообщества, чтобы информация, к которой необходимо получить доступ в нем, собиралась и обсуждалась с членами сообщества. Поскольку я предложил свой график выше, в соответствии с ним я смогу обсуждать и собирать информацию, необходимую в период моего взаимодействия с сообществом.

Я буду исследовать различные разделы в соответствии с CHAOSS и поддерживать обсуждения в списке рассылки. Я постараюсь задать уточняющие вопросы своим наставникам и сообществу в зависимости от требований.

Чтобы вести краткие обсуждения, я также буду участвовать в еженедельных телеконференциях.

3.) Как вы предполагаете информировать сообщество о своем прогрессе и любых проблемах или вопросах, которые могут возникнуть у вас в ходе проекта?

Чтобы обеспечить гибкость и прозрачность, я постараюсь обсудить мои сомнения в списке рассылки.

Я буду делиться своим еженедельным прогрессом в блоге, который будет включать документацию по Scrum и возникающим проблемам, которые будут опубликованы в самом списке рассылки сообщества, чтобы охватить более широкую аудиторию внутри организации с открытым исходным кодом.

Я также буду посещать еженедельные телеконференции сообщества, чтобы высказывать правильные предложения и обсуждать основные вопросы.

Я также планирую создать доску Trello с доступными еженедельными задачами. Затем наставники могут использовать эту доску, чтобы получить четкое и краткое представление о текущих проблемах и функциях, над которыми ведется работа.

4.) Что вы будете делать, если застрянете в своем проекте, а наставника нет рядом?

Я считаю, что роль наставника состоит в том, чтобы вести учеников в правильном направлении, а не объяснять ученику каждый уголок петли. Исследование и реализация проекта являются исключительной ответственностью студента. Помня об этом, я постараюсь получить помощь от своего наставника только в крайнем случае.

Однако, если наставника нет рядом или он не занят в тот момент, когда мне нужна помощь, я перейду к тому, чтобы поделиться своей проблемой с сообществом CHAOSS. Я уверен, что кто-то сможет помочь мне справиться с любыми трудностями, с которыми я сталкиваюсь. Я также поделюсь этой проблемой на онлайн-форумах/сообществах разработчиков, таких как dev.to.

Более того, я бы попробовал участвовать в любых еженедельных призывах о помощи в сообществе CHAOSS, чтобы выразить свои сомнения.