Project Jenkins X

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.

Ringkasan proyek

Organisasi open source:
Jenkins X
Penulis teknis:
Nitin
Nama proyek:
Pemfaktoran ulang situs dokumen Jenkins X yang ada dan Matriks Kemampuan Jenkins X
Durasi proyek:
Durasi standar (3 bulan)

Project description

Tujuan utama project ini adalah untuk memfaktorkan ulang dokumentasi Jenkins X yang ada, sekaligus memperbaiki masalah terkait dokumen, serta menyiapkan matriks kemampuan Jenkins X yang telah diupdate, beserta dokumentasi pengguna tentang penggunaan Jenkins X pada penyedia cloud perusahaan. Selain itu, project ini juga melibatkan pengembangan infrastruktur lingkungan pratinjau Jenkins X berdasarkan OpenShift, melalui kerja sama dengan Daniel.

Sebagai bagian dari pemfaktoran ulang dokumentasi Jenkins X yang ada, beberapa masalah yang akan saya tangani, meliputi:

  • Booting di Resource EKS: Masalah
  • Vault gagal di EKS dengan Boot: Masalah
  • Envar dokumen untuk booting jx: Masalah
  • Dokumentasi yang diperlukan untuk penyiapan Vault: Masalah
  • Upgrade booting dari lokal ke vault gagal: Masalah
  • Masukan Dokumentasi Hubungan “create” vs “install jx” vs “boot” vs “import”: Masalah
  • Dokumentasi Helm sudah ada di mana-mana: Masalah
  • Menyempurnakan dokumen mengapa ChartMuseum, Monocular, dan Docker Registry tidak diganti dengan Masalah Nexus
  • Tidak dapat mengubah Registry Docker saat menggunakan Boot + GKE: Masalah
  • Mengubah domain dari nip.io ke domain kustom gagal: Masalah

Untuk Matriks kemampuan Jenkins X, pekerjaan melibatkan (seperti yang disebutkan di bawah) untuk layanan Kubernetes perusahaan yang ditawarkan oleh setiap penyedia Cloud, yaitu, Google Cloud (GKE), Amazon Web Services (AWS EKS), dan Azure Cloud (AKS).

  • Penginstalan Jenkins X di cloud melalui skrip terraform dan jx boot
  • Memeriksa kompatibilitas versi Kubernetes dengan Jenkins X pada layanan kubernetes penyedia cloud ini.
  • Kemampuan lainnya (penyimpanan Vault untuk rahasia, versi Kontrol sumber, atau lainnya) yang akan didiskusikan dengan Deane dan anggota komunitas Jenkins X.

Terkait pekerjaan penyiapan infrastruktur lingkungan pratinjau Jenkins X berdasarkan OpenShift, pekerjaan ini meliputi:

  • Dokumen desain di Jenkins X melakukan pratinjau infrastruktur lingkungan di platform OpenShift
  • Mengotomatiskan pembuatan lingkungan pratinjau Jenkins X di OpenShift
  • Memperbarui dokumentasi untuk Jenkins X di lingkungan pratinjau

{i>Deliverable<i} (Hasil Kerja Proyek):

  • Perbaikan melalui PR untuk masalah dokumen yang disebutkan di atas, sebagai pertimbangan pemfaktoran ulang dokumentasi Jenkins X yang ada.
  • Mengupdate Matriks Kemampuan Jenkins X beserta dokumentasi pengguna tentang penggunaan Jenkins X dengan berbagai penyedia cloud (layanan Kubernetes terutama AKS, EKS, dan GKE).
  • Penyiapan otomatis Infrastruktur lingkungan pratinjau Jenkins X berdasarkan OpenShift, bekerja sama dengan Daniel.

Linimasa Tentatif (bersama dengan tugas-tugas) yang diusulkan:

Ikatan Komunitas (17 Agu - 13 Sep)

  • Menyiapkan Lingkungan pengembangan untuk dokumentasi teknis serta mendapatkan akses ke infrastruktur Cloud untuk mengerjakan tugas project.
  • Diskusi dengan mentor proyek tentang rentang waktu tentatif yang diusulkan, hasil proyek serta tugas-tugas (beserta prioritas mereka).
  • Memahami dan membekali dengan baik dengan proses kerja organisasi, proses peninjauan PR, dan terlibat dengan komunitas.
  • Meninjau status dokumentasi Jenkins X saat ini.

Minggu ke-1 (14 Sep - 20 Sep)

  • Memahami petunjuk penyiapan Jenkins X di cloud, status saat ini, dan dokumentasi.
  • Diskusi dengan Deane, tentang kemampuan Jenkins X saat ini (untuk diverifikasi di berbagai penyedia cloud).
  • Diskusi dengan Daniel tentang kondisi infrastruktur lingkungan pratinjau Jenkins X saat ini berdasarkan OpenShift.
  • Bekerja (bekerja sama dengan Daniel) dalam mendesain arsitektur untuk pratinjau infrastruktur lingkungan Jenkins X di OpenShift.

Minggu ke-2 (21 Sep - 27 Sep)

  • Mengerjakan matriks kemampuan Jenkins X untuk cloud GKE: penginstalan Jenkins X dan menyiapkan draf catatan pengguna.
  • Mengerjakan salah satu masalah dokumen untuk meningkatkan kualitas dokumentasi Jenkins X yang ada.

Minggu ke-3 (28 Sep - 4 Okt)

  • Mengerjakan matriks kemampuan Jenkins X untuk cloud GKE: penginstalan Jenkins X dan menyiapkan draf catatan pengguna.
  • Mengerjakan salah satu masalah dokumen untuk meningkatkan kualitas dokumentasi Jenkins X yang ada.
  • Mengerjakan Dokumen Desain untuk infrastruktur lingkungan pratinjau Jenkins X berdasarkan OpenShift.

Minggu 4 (5 Okt - 11 Okt)

  • Menyelesaikan dokumen pengguna untuk Jenkins X di GKE.
  • Mengerjakan salah satu masalah dokumen untuk meningkatkan kualitas dokumentasi Jenkins X yang ada.

Minggu 5 (12 Okt - 18 Okt)

  • Mengerjakan matriks kemampuan Jenkins X untuk Azure cloud (AKS): penginstalan Jenkins X dan menyiapkan draf catatan pengguna.
  • Mengerjakan salah satu masalah dokumen untuk meningkatkan kualitas dokumentasi Jenkins X yang ada.
  • Selesaikan dokumen desain infrastruktur lingkungan pratinjau Jenkins X berdasarkan OpenShift, setelah mendapatkan masukan dari anggota komunitas.

Minggu 6 (19 Okt - 25 Okt)

  • Mengerjakan matriks kemampuan Jenkins X untuk Azure cloud (AKS): penginstalan Jenkins X dan menyiapkan draf catatan pengguna.
  • Mengerjakan salah satu masalah dokumen untuk meningkatkan kualitas dokumentasi Jenkins X yang ada.

Minggu 7 (26 Okt - 1 Nov)

  • Mengerjakan matriks kemampuan Jenkins X untuk Azure cloud (AKS): penginstalan Jenkins X dan menyiapkan draf catatan pengguna.
  • Mengerjakan salah satu masalah dokumen untuk meningkatkan kualitas dokumentasi Jenkins X yang ada.
  • Menyelesaikan penyiapan infrastruktur lingkungan pratinjau Jenkins X berdasarkan OpenShift.

Minggu ke-8 (2 Nov - 8 Nov)

  • Menyelesaikan dokumen pengguna untuk Jenkins X di AKS.
  • Mengerjakan salah satu masalah dokumen untuk meningkatkan kualitas dokumentasi Jenkins X yang ada.

Minggu ke-9 (9 Nov - 15 Nov)

  • Mengerjakan matriks kemampuan Jenkins X untuk AWS (EKS): penginstalan Jenkins X dan menyiapkan draf catatan pengguna.
  • Mengerjakan salah satu masalah dokumen untuk meningkatkan kualitas dokumentasi Jenkins X yang ada.
  • Menyelesaikan penyiapan infrastruktur lingkungan pratinjau Jenkins X berdasarkan OpenShift.

Minggu ke-10 (16 Nov - 22 Nov)

  • Mengerjakan matriks kemampuan Jenkins X untuk AWS (EKS): penginstalan Jenkins X dan menyiapkan draf catatan pengguna.
  • Mengerjakan salah satu masalah dokumen untuk meningkatkan kualitas dokumentasi Jenkins X yang ada.

Minggu 11 (23 Nov - 29 Nov)

  • Menyelesaikan dokumen pengguna untuk Jenkins X di EKS.
  • Mengerjakan salah satu masalah dokumen untuk meningkatkan kualitas dokumentasi Jenkins X yang ada.
  • Menyelesaikan dokumentasi infrastruktur lingkungan pratinjau Jenkins X di situs dokumen Jenkins X.

Minggu ke-12 (30 Nov - 5 Des)

  • Menyelesaikan hasil proyek dan memfaktorkan ulang kode jika ada, berdasarkan umpan balik tersebut.
  • Menguji cara kerja situs dokumen Jenkins X termasuk link, gambar, hyperlink, dan lainnya.
  • Periksa kontrol dan navigasi yang ditentukan pengguna untuk situs dokumen Jenkins X.
  • Periksa presentasi akhir matriks Jenkins X Capabilites.

Sebelum 10 Desember 2020 Penulis Teknis dan Mentor mengirimkan evaluasi project.

Apa manfaat project yang diusulkan bagi Jenkins X dan komunitasnya? Project ini akan membantu komunitas Jenkins X meningkatkan kualitas dokumentasi bagi pengguna akhirnya serta developer sebagai referensi terkait arsitektur teknis, kompatibilitas, penggunaan, dan integrasi Jenkins X. Setelah project yang diusulkan ini selesai, akan ada dokumentasi pengguna Jenkins X yang lengkap, terdefinisi dengan baik, dan terverifikasi secara teknis, beserta Matriks Kemampuan Jenkins X untuk kompatibilitasnya dengan berbagai penyedia cloud.

Apa manfaat yang akan Anda peroleh dengan Jenkins X? Setelah program Google Season untuk Dokumen 2020 berakhir, saya berencana untuk menjadi kontributor jangka panjang pada project Jenkins X sebagai anggota aktif komunitas. Saya akan selalu ada untuk membantu orang lain (pendatang baru) dan mendorong mereka untuk terlibat dalam komunitas Jenkins X. Saya akan selalu bersedia mengerjakan ide project Jenkins X lainnya.

Beberapa alasan yang membuat saya paling cocok untuk mengerjakan proyek ini:

  • Saya sangat metodis dan terorganisir. Saya sangat berharap untuk terus mendapatkan informasi tentang kemajuan proyek baik kepada mentor proyek dan komunitas organisasi melalui postingan blog seminggu sekali, pertemuan mingguan yang dijadwalkan di SIG-docs, dan melalui email secara teratur.
  • Akan mencari bimbingan serta masukan dari mentor dan anggota komunitas secara berkala, sehingga untuk maju dengan tugas dan memastikan semua orang memiliki pemahaman yang sama (termasuk menyebutkan tantangan dan/atau titik pemblokiran yang dihadapi).
  • Mengirimkan semua kode sumber yang ditulis secara teratur agar kode ditinjau dari mentor, kontributor, dan mendokumentasikan pekerjaan yang dilakukan sebagai referensi kepada anggota komunitas.
  • Saya memiliki semua keterampilan teknis yang diperlukan untuk mengerjakan ide proyek ini dan telah mendiskusikan proposal proyek dengan para mentor Deane, Kara, dan Daniel. Saya memiliki pemahaman mendalam tentang proposal proyek dan hasilnya.
  • Saya memiliki pengalaman menggunakan keterampilan teknis (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo, dan lainnya) yang diperlukan untuk memberikan dokumentasi lengkap serta memecahkan sebagian besar masalah terkait dokumentasi terbaru. Saya memiliki sikap positif yang bisa menyelesaikan pekerjaan proyek tepat waktu dengan sedikit pengawasan.