Jenkins X プロジェクト

このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。

プロジェクトの概要

オープンソース組織:
Jenkins X
テクニカル ライター:
Nitin
プロジェクト名:
既存の Jenkins X ドキュメント サイトと Jenkins X 機能マトリックスのリファクタリング
プロジェクトの長さ:
標準期間（3 か月）

プロジェクトの説明

このプロジェクトの主な目的は、既存の Jenkins X ドキュメントをリファクタリングし、ドキュメント関連の問題を修正すること、および更新された Jenkins X 機能マトリックスと、エンタープライズ クラウド プロバイダでの Jenkins X の使用に関するユーザー ドキュメントを準備することです。さらに、このプロジェクトには、Daniel とのコラボレーションにより、OpenShift をベースとした Jenkins X プレビュー環境インフラストラクチャの開発も含まれています。

既存の Jenkins X ドキュメントのリファクタリングの一環として、取り組む問題の一部を以下に示します。

  • EKS リソースでの起動: 問題
  • EKS で Vault が起動して失敗する: 問題
  • jx ブートの環境変数を記述: 問題
  • Vault のセットアップに必要なドキュメント: 問題
  • ローカルから Vault へのブートアップグレードが失敗する: 問題
  • ドキュメントのフィードバック「create」と「install jx」、「boot」、「import」の関係: 問題
  • Helm のドキュメントが散在している: 問題
  • ChartMuseum、Monocular、Docker Registry が Nexus の問題に置き換えられていない理由に関するドキュメントを改善
  • Boot + GKE を使用しているときに Docker レジストリを変更できない: 問題
  • ドメインを nip.io からカスタム ドメインに変更できない: 問題

Jenkins X の機能マトリックスについては、各クラウド プロバイダが提供するエンタープライズ Kubernetes サービス、つまり、Google Cloud（GKE）、アマゾン ウェブ サービス（AWS EKS）、Azure Cloud（AKS）。

  • Terraform スクリプトと jx boot を使用したクラウドへの Jenkins X のインストール
  • これらのクラウド プロバイダの Kubernetes サービスで、Kubernetes バージョンと Jenkins X の互換性を確認します。
  • その他の機能（シークレット用の Vault ストレージ、ソース管理のバージョンなど）については、Deane と Jenkins X コミュニティのメンバーと話し合ってください。

OpenShift に基づく Jenkins X プレビュー環境インフラストラクチャのセットアップに関する作業は、以下のとおりです。

  • OpenShift プラットフォーム上の Jenkins X プレビュー環境インフラストラクチャに関する設計ドキュメント
  • OpenShift で Jenkins X プレビュー環境の作成を自動化する
  • プレビュー環境での Jenkins X のドキュメントを更新

プロジェクトの成果物:

  • 既存の Jenkins X ドキュメントのリファクタリングを考慮して、上記のドキュメントの問題を PR で修正しました。
  • さまざまなクラウド プロバイダ（主に AKS、EKS、GKE の Kubernetes サービス）で Jenkins X を使用する際のユーザー ドキュメントとともに、Jenkins X の機能マトリックスを更新しました。
  • Daniel との共同作業で、OpenShift ベースの Jenkins X プレビュー環境のインフラストラクチャの自動設定。

提案された暫定的なタイムライン（タスクとともに）:

コミュニティ ボンディング（8 月 17 日～ 9 月 13 日）

  • 技術ドキュメント用の開発環境を設定し、プロジェクトのタスクを処理するために Cloud インフラストラクチャにアクセスします。
  • 提案された暫定的なタイムライン、プロジェクトの成果物、タスク（優先度とともに）について、プロジェクト メンターと話し合います。
  • 組織の業務プロセスと PR の審査プロセスを理解し、コミュニティに参加します。
  • Jenkins X のドキュメントの状態を確認します。

第 1 週（9 月 14 日～ 9 月 20 日）

  • クラウドでの Jenkins X の設定手順、現在の状態、ドキュメントについて理解します。
  • 現在の Jenkins X の機能について Deane と話し合います（さまざまなクラウド プロバイダで検証します）。
  • OpenShift に基づく Jenkins X プレビュー環境インフラストラクチャの現状について、Daniel とディスカッションを行います。
  • Daniel と協力して、OpenShift 上の Jenkins X プレビュー環境インフラストラクチャのアーキテクチャを設計します。

第 2 週（9 月 21 日～ 9 月 27 日）

  • GKE Cloud の Jenkins X の機能マトリックスに取り組みます。Jenkins X のインストールとユーザーメモの下書きの準備を行います。
  • 既存の Jenkins X ドキュメントの改善に向けて、docs-issue のいずれかに対応します。

第 3 週（9 月 28 日～ 10 月 4 日）

  • GKE Cloud の Jenkins X の機能マトリックス（Jenkins X のインストールとユーザーメモの下書きの準備）に取り組みます。
  • 既存の Jenkins X ドキュメントの改善に向けて、docs-issue のいずれかに対応します。
  • OpenShift ベースの Jenkins X プレビュー環境インフラストラクチャの設計ドキュメントを作成します。

第 4 週（10 月 5 日～ 10 月 11 日）

  • GKE での Jenkins X のユーザー ドキュメントを確定します。
  • 既存の Jenkins X ドキュメントの改善に向けて、docs-issue のいずれかに対応します。

第 5 週（10 月 12 日～ 10 月 18 日）

  • Azure Cloud（AKS）の Jenkins X 機能マトリックスの作業: Jenkins X のインストールとユーザーメモの下書きの準備。
  • 既存の Jenkins X ドキュメントの改善に向けて、docs-issue のいずれかに対応します。
  • コミュニティ メンバーからフィードバックを得た後、OpenShift に基づく Jenkins X プレビュー環境インフラストラクチャの設計ドキュメントを確定する。

第 6 週（10 月 19 日～ 10 月 25 日）

  • Azure Cloud（AKS）の Jenkins X 機能マトリックスの作業: Jenkins X のインストールとユーザーメモの下書きの準備。
  • 既存の Jenkins X ドキュメントの改善に向けて、docs-issue のいずれかに対応します。

第 7 週（10 月 26 日～ 11 月 1 日）

  • Azure Cloud（AKS）の Jenkins X 機能マトリックスの作業: Jenkins X のインストールとユーザーメモの下書きの準備。
  • 既存の Jenkins X ドキュメントを改善するために、docs-issue のいずれかに対応します。
  • OpenShift に基づく Jenkins X プレビュー環境のインフラストラクチャの設定に取り組みます。

第 8 週（11 月 2 日～ 11 月 8 日）

  • AKS で Jenkins X のユーザー ドキュメントを確定します。
  • 既存の Jenkins X ドキュメントの改善に向けて、docs-issue のいずれかに対応します。

第 9 週（11 月 9 日～ 11 月 15 日）

  • AWS（EKS）向け Jenkins X 機能マトリックス（Jenkins X のインストールとユーザーメモの下書き）に取り組む。
  • 既存の Jenkins X ドキュメントを改善するために、docs-issue の 1 つに対処します。
  • OpenShift に基づく Jenkins X プレビュー環境インフラストラクチャのセットアップに取り組む。

第 10 週（11 月 16 日～ 11 月 22 日）

  • AWS（EKS）の Jenkins X 機能マトリックスの作業: Jenkins X のインストールとユーザーメモの下書きの準備。
  • 既存の Jenkins X ドキュメントの改善に向けて、docs-issue のいずれかに対応します。

第 11 週（11 月 23 日～ 11 月 29 日）

  • EKS 上の Jenkins X のユーザー ドキュメントを確定しました。
  • 既存の Jenkins X ドキュメントの改善に向けて、docs-issue のいずれかに対応します。
  • Jenkins X ドキュメント サイトで、Jenkins X プレビュー環境インフラストラクチャのドキュメントを完成させます。

第 12 週（11 月 30 日～ 12 月 5 日）

  • プロジェクトの成果物を確定し、フィードバックに基づいてコードをリファクタリングする。
  • リンク、画像、ハイパーリンクなど、Jenkins X のドキュメント サイトの動作をテストします。
  • Jenkins X のドキュメント サイトのユーザー定義のコントロールとナビゲーションを確認します。
  • Jenkins X の機能マトリックスの最終的なプレゼンテーションを確認します。

2020 年 12 月 10 日より前に、技術ライターとメンターの両方がプロジェクトの評価を提出します。

提案されたプロジェクトは、Jenkins X とそのコミュニティにどのようなメリットをもたらしますか。このプロジェクトは、Jenkins X コミュニティがエンドユーザーおよび開発者向けに、Jenkins X の技術的なアーキテクチャ、互換性、使用方法、統合について参考になるドキュメントを改善するのに役立ちます。この提案されたプロジェクトが完了すると、Jenkins X の完全な、明確に定義され、技術的に検証されたユーザー ドキュメントと、さまざまなクラウド プロバイダとの互換性に関する Jenkins X 機能マトリックスが存在することになります。

Jenkins X で今後どのようなメリットを享受したいとお考えですか？Google Season of Docs 2020 プログラムの終了後には、コミュニティのアクティブなメンバーとして、Jenkins X プロジェクトの長期的なコントリビューターになる予定です。他のユーザー（新規ユーザー）をサポートし、Jenkins X コミュニティに参加するよう促すために、私は常にサポートを続けていきます。他の Jenkins X プロジェクトのアイデアにも常に取り組んでいます。

私がこのプロジェクトに最適な理由をいくつかご紹介します。

  • 私は非常に計画的かつ整理整頓が得意です。プロジェクト メンターと組織コミュニティの両方に、週に 1 回のブログ投稿、スケジュール設定された SIG-docs の週次ミーティング、定期的なメールでプロジェクトの進捗状況を通知することを強く推奨します。
  • タスクを進めて全員が同じ方向に進むように、メンターやコミュニティ メンバーから頻繁にガイダンスやフィードバックを求められるでしょう（直面している課題やブロックポイントについても言及します）。
  • 定期的に記述するすべてのソースコードを commit して、メンターやコントリビューターからコードのレビューを受け、コミュニティ メンバーが参照できるように作業内容を文書化する。
  • 私は、このプロジェクトのアイデアに取り組み、必要な技術スキルをすべて備えています。また、プロジェクトの提案について、メンターのディーンとカラ、ダニエルと話し合いました。プロジェクトの提案書とその成果物について理解を深めました。
  • 本格的なドキュメントを提供し、現在のドキュメント関連の問題のほとんどを解決するために必要な技術スキル（Google Cloud、Azure Cloud、AWS、Kubernetes、OpenShift、Hugo など）を使用した経験があります。プロジェクトの作業をほとんど監督なしで期限までに完了できる、前向きで積極的な姿勢を持っています。