Jenkins X プロジェクト

このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。

プロジェクトの概要

オープンソースの組織:
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 Issue で置き換えられない理由のドキュメントを改善
  • ブートと 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 を通じて修正しました。
  • Jenkins X の機能マトリックスを更新し、さまざまなクラウド プロバイダ（主に AKS、EKS、GKE）での Jenkins X の使用に関するユーザー ドキュメントを更新しました。
  • Daniel と共同で、OpenShift ベースの Jenkins X プレビュー環境インフラストラクチャを自動的に設定します。

暫定的なタイムライン（タスクと合わせて）の提案:

コミュニティの絆（8 月 17 日～ 9 月 13 日）

  • 技術ドキュメント用の開発環境を設定するほか、プロジェクトのタスクを実施するためのクラウド インフラストラクチャへのアクセス権を取得する。
  • 提案した暫定的なタイムライン、プロジェクトの成果物、タスク（およびその優先度）について、プロジェクト メンターと話し合います。
  • 組織の作業プロセスと PR レビュー プロセスを理解し、十分な機能を備えることで、コミュニティとの関わりを深めます。
  • Jenkins X の現在のドキュメントの状態を確認する。

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

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

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

  • GKE クラウド向け Jenkins X 機能マトリックスでの作業: Jenkins X のインストールとユーザーメモの下書きの準備
  • ドキュメントに関する問題の 1 つに取り組み、既存の Jenkins X のドキュメントを改善します。

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

  • GKE クラウド向け Jenkins X 機能マトリックスでの作業: Jenkins X のインストールとユーザーメモの下書きの準備
  • ドキュメントに関する問題の 1 つに取り組み、既存の Jenkins X のドキュメントを改善します。
  • OpenShift に基づく Jenkins X プレビュー環境インフラストラクチャの設計ドキュメントの作成

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

  • GKE 上の Jenkins X のユーザー ドキュメントを完成させます。
  • ドキュメントに関する問題の 1 つに取り組み、既存の Jenkins X のドキュメントを改善します。

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

  • Azure クラウド（AKS）向け Jenkins X 機能マトリックスで作業する: Jenkins X のインストールとユーザーメモの下書きの準備。
  • ドキュメントに関する問題の 1 つに取り組み、既存の Jenkins X のドキュメントを改善します。
  • コミュニティ メンバーからフィードバックを得て、OpenShift をベースとした Jenkins X プレビュー環境インフラストラクチャの設計ドキュメントを完成させます。

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

  • Azure クラウド（AKS）向け Jenkins X 機能マトリックスで作業する: Jenkins X のインストールとユーザーメモの下書きの準備。
  • ドキュメントに関する問題の 1 つに取り組み、既存の Jenkins X のドキュメントを改善します。

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

  • Azure クラウド（AKS）向け Jenkins X 機能マトリックスで作業する: Jenkins X のインストールとユーザーメモの下書きの準備。
  • ドキュメントに関する問題の 1 つに取り組み、既存の Jenkins X のドキュメントを改善します。
  • OpenShift に基づく Jenkins X プレビュー環境のインフラストラクチャの設定に取り組みます。

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

  • AKS 上の Jenkins X のユーザー ドキュメントを完成させます。
  • ドキュメントに関する問題の 1 つに取り組み、既存の Jenkins X のドキュメントを改善します。

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

  • AWS（EKS）向け Jenkins X 機能マトリックスでの作業: Jenkins X のインストールとユーザーメモの下書きの準備
  • ドキュメントに関する問題の 1 つに取り組み、既存の Jenkins X のドキュメントを改善します。
  • OpenShift に基づく Jenkins X プレビュー環境のインフラストラクチャの設定に取り組みます。

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

  • AWS（EKS）向け Jenkins X 機能マトリックスでの作業: Jenkins X のインストールとユーザーメモの下書きの準備
  • ドキュメントに関する問題の 1 つに取り組み、既存の Jenkins X のドキュメントを改善します。

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

  • EKS で Jenkins X のユーザー ドキュメントを完成させます。
  • ドキュメントに関する問題の 1 つに取り組み、既存の Jenkins X のドキュメントを改善します。
  • 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 シーズンの Google ドキュメント 2020 プログラム終了後、私はコミュニティの活発なメンバーとして、Jenkins X プロジェクトに長期的に貢献することを計画しています。今後も他のユーザー（初めて参加される人）を手助けし、Jenkins X コミュニティに参加するようにすすめていきます。他の Jenkins X プロジェクトのアイデアにも前向きに取り組みたいと思っています。

私がこのプロジェクトに取り組むのが最適である理由として、以下が挙げられます。

  • 私はとても体系的で、整理整頓が得意です。プロジェクトの進捗に関する最新情報は、週に 1 回ブログ投稿、SIG-docs の週 1 回ミーティング、メールなどを通じて、プロジェクトのメンターと組織コミュニティに常に知らせておきたいと思います。
  • メンターやコミュニティ メンバーの指導やフィードバックを頻繁に求めてタスクに取り組み、全員が同じ認識を持てるようにする（直面した課題や阻害点を包括的に言及する）。
  • 定期的に作成したすべてのソースコードを commit して、メンターやコントリビューターにコードをレビューしてもらい、コミュニティ メンバーが参照できるように作業内容を文書化します。
  • 私は、このプロジェクトのアイデアに取り組むために必要な技術的スキルをすべて備えており、メンターの Deane、Kara、Daniel とプロジェクト提案について話し合いました。プロジェクト提案と成果物について深く理解できた。
  • 本格的なドキュメントを提供したり、現在のドキュメント関連の問題のほとんどを解決するために必要な技術スキル（Google Cloud、Azure Cloud、AWS、Kubernetes、OpenShift、Hugo など）を使った経験があります。ポジティブな姿勢で、ほとんど監督しなくてもプロジェクトを予定どおりにこなせる。