Проект Дженкинса X

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

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

Организация с открытым исходным кодом:
Дженкинс Икс
Технический писатель:
Нитин
Название проекта:
Рефакторинг существующего сайта документации Jenkins X и матрицы возможностей Jenkins X.
Длина проекта:
Стандартная продолжительность (3 месяца)

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

Основная цель этого проекта — реорганизовать существующую документацию Jenkins X, одновременно устраняя проблемы, связанные с документацией, а также подготовить обновленную матрицу возможностей Jenkins X вместе с пользовательской документацией по использованию Jenkins X у корпоративных облачных провайдеров. Кроме того, этот проект также предполагает работу над разработкой инфраструктуры среды предварительного просмотра Jenkins X на основе OpenShift в сотрудничестве с Дэниелом.

В рамках рефакторинга существующей документации Jenkins X я буду работать над некоторыми проблемами:

  • Загрузка ресурсов EKS: проблема
  • Сбой хранилища в EKS при загрузке: проблема
  • Конверты документов для загрузки jx: проблема
  • Документация, необходимая для настройки Vault: проблема
  • Не удалось обновить загрузку с локального хранилища до хранилища: проблема
  • Обратная связь с документацией. Связь между «созданием», «установкой jx», «загрузкой» и «импортом»: проблема
  • Документация Helm повсюду: проблема
  • Улучшите документацию, почему ChartMuseum, Monocular и Docker Registry не заменяются Nexus Issue.
  • Невозможно изменить реестр Docker при использовании Boot + GKE: проблема
  • Сменить домен с nip.io на собственный домен не удается: проблема

Что касается матрицы возможностей Jenkins X, работа включает (как указано ниже) корпоративные сервисы Kubernetes, предлагаемые каждым из поставщиков облачных услуг, т. е. Google Cloud (GKE), Amazon Web Services (AWS EKS) и Azure Cloud (AKS).

  • Установка Jenkins X в облаке с помощью скриптов terraform и jx boot
  • Проверка совместимости версий Kubernetes с Jenkins X в службах Kubernetes этих облачных провайдеров.
  • Любые другие возможности (хранилище для секретов, версии системы контроля версий и т. д.) подлежат обсуждению с Дином и членами сообщества Jenkins X.

Что касается работ по настройке инфраструктуры среды предварительного просмотра Jenkins X на базе OpenShift, то работы включают в себя:

  • Проектный документ по инфраструктуре среды предварительного просмотра Jenkins X на платформе OpenShift
  • Автоматизируйте создание сред предварительного просмотра Jenkins X в OpenShift.
  • Обновите документацию для Jenkins X в средах предварительной версии.

Результаты проекта:

  • Исправления через PR вышеупомянутых проблем с документацией с учетом рефакторинга существующей документации Jenkins X.
  • Обновлена ​​матрица возможностей Jenkins X вместе с пользовательской документацией по использованию Jenkins X с различными поставщиками облачных услуг (службы Kubernetes в основном AKS, EKS и GKE).
  • Автоматизированная настройка среды предварительного просмотра Jenkins X. Инфраструктура на основе OpenShift в сотрудничестве с Дэниелом.

Предлагаемый ориентировочный график (вместе с задачами):

Связывание сообщества (17 августа – 13 сентября)

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

Неделя 1 (14 – 20 сентября)

  • Ознакомьтесь с инструкциями по настройке Jenkins X в облаке, текущим состоянием и документацией.
  • Обсуждение с Дином текущих возможностей Jenkins X (подлежит проверке у разных облачных провайдеров).
  • Обсуждение с Дэниелом текущего состояния инфраструктуры среды предварительного просмотра Jenkins X на основе OpenShift.
  • Работать (в сотрудничестве с Дэниелом) над проектированием архитектуры для инфраструктуры среды предварительного просмотра Jenkins X на OpenShift.

Неделя 2 (21 сентября – 27 сентября)

  • Работа над матрицей возможностей Jenkins X для облака GKE: установка Jenkins X и подготовка черновых заметок для пользователя.
  • Работа над одним из вопросов документации по улучшению существующей документации Jenkins X.

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

  • Работа над матрицей возможностей Jenkins X для облака GKE: установка Jenkins X и подготовка черновых заметок для пользователя.
  • Работа над одним из вопросов документации по улучшению существующей документации Jenkins X.
  • Работа над проектным документом для инфраструктуры среды предварительного просмотра Jenkins X на основе OpenShift.

Неделя 4 (5 октября – 11 октября)

  • Завершите пользовательскую документацию для Jenkins X в GKE.
  • Работа над одним из вопросов документации по улучшению существующей документации Jenkins X.

Неделя 5 (12 октября – 18 октября)

  • Работа над матрицей возможностей Jenkins X для облака Azure (AKS): установка Jenkins X и подготовка черновых заметок для пользователя.
  • Работа над одним из вопросов документации по улучшению существующей документации Jenkins X.
  • Завершить разработку проектного документа для инфраструктуры среды предварительной версии Jenkins X на основе OpenShift после получения отзывов от членов сообщества.

Неделя 6 (19 октября – 25 октября)

  • Работа над матрицей возможностей Jenkins X для облака Azure (AKS): установка Jenkins X и подготовка черновых заметок для пользователя.
  • Работа над одним из вопросов документации по улучшению существующей документации Jenkins X.

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

  • Работа над матрицей возможностей Jenkins X для облака Azure (AKS): установка Jenkins X и подготовка черновых заметок для пользователя.
  • Работа над одним из вопросов документации по улучшению существующей документации Jenkins X.
  • Работа над настройкой инфраструктуры среды предварительного просмотра Jenkins X на основе OpenShift.

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

  • Завершите подготовку пользовательской документации для Jenkins X в AKS.
  • Работа над одним из вопросов документации по улучшению существующей документации Jenkins X.

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

  • Работа над матрицей возможностей Jenkins X для AWS (EKS): установка Jenkins X и подготовка черновых заметок для пользователя.
  • Работа над одним из вопросов документации по улучшению существующей документации Jenkins X.
  • Работа над настройкой инфраструктуры среды предварительного просмотра Jenkins X на основе OpenShift.

Неделя 10 (16 – 22 ноября)

  • Работа над матрицей возможностей Jenkins X для AWS (EKS): установка Jenkins X и подготовка черновых заметок для пользователя.
  • Работа над одним из вопросов документации по улучшению существующей документации Jenkins X.

Неделя 11 (23 – 29 ноября)

  • Завершите пользовательскую документацию для Jenkins X на EKS.
  • Работа над одним из вопросов документации по улучшению существующей документации Jenkins X.
  • Завершите документацию по инфраструктуре среды предварительного просмотра Jenkins X на сайте документации Jenkins X.

Неделя 12 (30 ноября – 5 декабря)

  • Доработайте результаты проекта и проведите рефакторинг кода, если таковой имеется, на основе отзывов.
  • Проверьте работу сайта документации Jenkins X, включая ссылки, изображения, гиперссылки и т. д.
  • Проверьте определяемые пользователем элементы управления и навигацию на сайте документации Jenkins X.
  • Ознакомьтесь с окончательной презентацией матрицы возможностей Jenkins X.

До 10 декабря 2020 г. Технический писатель и наставники представляют оценку проекта.

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

Какие будущие преимущества вы планируете реализовать с Jenkins X? После окончания программы Google Season of Docs 2020 я планирую стать долгосрочным участником проекта Jenkins X в качестве активного члена сообщества. Я всегда буду рядом, чтобы помочь другим (новичкам) и призвать их принять участие в сообществе Jenkins X. Я всегда был бы готов поработать над другими идеями проекта Jenkins X.

Некоторые из причин, по которым я лучше всего подхожу для работы над этим проектом:

  • Я очень методичен и организован. Я очень надеюсь, что буду информировать о ходе проекта как наставников проекта, так и сообщество организации через сообщения в блоге раз в неделю, запланированные еженедельные встречи SIG-docs и по электронной почте на регулярной основе.
  • Будет часто обращаться за советом, а также обратной связью к наставникам и членам сообщества, чтобы продвигаться вперед в выполнении задач и гарантировать, что все будут на одной волне (включая упоминание о любых проблемах и/или блокирующих моментах, с которыми можно столкнуться).
  • Регулярная передача всего написанного исходного кода для проверки кода наставником, участниками и документирование проделанной работы для справки членам сообщества.
  • У меня есть все необходимые технические навыки, необходимые для работы над этой идеей проекта, и я обсудил предложение проекта с наставниками Дином, Карой и Дэниелом. У меня есть глубокое понимание проектного предложения и его результатов.
  • У меня есть опыт работы с техническими навыками (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo и другими), необходимыми для предоставления полноценной документации, а также для решения большинства текущих проблем, связанных с документацией. У меня позитивный настрой: я могу выполнить работу по проекту вовремя без особого контроля.