Project Jenkins X

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

Ringkasan proyek

Organisasi open source:
Jenkins X
{i>Technical writer <i}(Penulis teknis):
Nitin
Nama project:
Memfaktorkan ulang situs dokumen Jenkins X yang ada dan Matriks Kemampuan Jenkins X
Durasi project:
Durasi standar (3 bulan)

Project description

Tujuan utama project ini adalah memfaktorkan ulang dokumentasi Jenkins X yang ada sekaligus memperbaiki masalah terkait dokumen serta menyiapkan matriks kemampuan Jenkins X yang diperbarui beserta dokumentasi pengguna tentang penggunaan Jenkins X di penyedia cloud perusahaan. Selain itu, project ini juga melibatkan pengembangan infrastruktur lingkungan pratinjau Jenkins X berdasarkan OpenShift, yang dilakukan melalui kolaborasi 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
  • Mendokumentasikan envars 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 tersebar di mana-mana: Masalah
  • Meningkatkan kualitas dokumen tentang alasan 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 menjadi domain kustom gagal: Masalah

Untuk Matriks kemampuan Jenkins X, pekerjaan ini 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 di layanan Kubernetes penyedia cloud ini.
  • Kemampuan lainnya (penyimpanan Vault untuk secret, versi Kontrol sumber, atau lainnya) yang akan dibahas dengan Deane dan anggota komunitas Jenkins X.

Sehubungan dengan pekerjaan penyiapan infrastruktur lingkungan pratinjau Jenkins X berdasarkan OpenShift, pekerjaan tersebut mencakup:

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

Hasil Kerja Project:

  • Perbaikan melalui PR untuk masalah dokumen yang disebutkan di atas, dengan pertimbangan pemfaktoran ulang dokumentasi Jenkins X yang ada.
  • Memperbarui 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, dalam kolaborasi dengan Daniel.

Linimasa Sementara (beserta tugas) yang diusulkan:

Ikatan Komunitas (17 Agustus - 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 sementara yang diusulkan, hasil proyek serta tugas-tugas (bersama dengan prioritas mereka).
  • Pahami dan persiapkan dengan baik proses kerja organisasi, proses peninjauan PR, dan terlibat dengan komunitas.
  • Tinjau status dokumentasi Jenkins X saat ini.

Minggu ke-1 (14 - 20 September)

  • Pahami petunjuk untuk 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 status infrastruktur lingkungan pratinjau Jenkins X saat ini berdasarkan OpenShift.
  • Bekerja (berkolaborasi dengan Daniel) untuk mendesain arsitektur untuk infrastruktur lingkungan pratinjau Jenkins X di OpenShift.

Minggu ke-2 (21 September - 27 September)

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

Minggu ke-3 (28 Sep - 4 Okt)

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

Minggu ke-4 (5 Okt - 11 Okt)

  • Selesaikan dokumen pengguna untuk Jenkins X di GKE.
  • Kerjakan salah satu masalah dokumen untuk meningkatkan dokumentasi Jenkins X yang ada.

Minggu ke-5 (12 Okt - 18 Okt)

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

Minggu ke-6 (19 Okt - 25 Okt)

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

Minggu ke-7 (26 Okt - 1 Nov)

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

Minggu ke-8 (2 Nov - 8 Nov)

  • Menyelesaikan dokumen pengguna untuk Jenkins X di AKS.
  • Kerjakan salah satu masalah dokumen untuk meningkatkan 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.
  • Kerjakan salah satu masalah dokumen untuk meningkatkan dokumentasi Jenkins X yang ada.
  • Bekerja pada Menyiapkan infrastruktur lingkungan pratinjau Jenkins X berdasarkan OpenShift.

Minggu ke-10 (16 November - 22 November)

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

Minggu ke-11 (23 November - 29 November)

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

Minggu ke-12 (30 November - 5 Desember)

  • Selesaikan hasil project dan faktorkan ulang kode jika ada, berdasarkan masukan.
  • Uji cara kerja situs dokumen Jenkins X, termasuk link, gambar, hyperlink, dan lainnya.
  • Periksa kontrol dan navigasi yang ditentukan pengguna di situs dokumen Jenkins X.
  • Periksa presentasi matriks Kemampuan Jenkins X yang telah selesai.

Sebelum 10 Desember 2020 Technical Writer dan Mentor mengirimkan evaluasi project.

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

Manfaat apa yang akan Anda kerjakan di masa mendatang dengan Jenkins X? Setelah program Google Season of Docs 2020 berakhir, saya berencana untuk menjadi kontributor jangka panjang pada project Jenkins X sebagai anggota aktif komunitas. Saya akan selalu siap membantu orang lain (pendatang baru) dan mendorong mereka untuk terlibat dalam komunitas Jenkins X. Saya akan selalu bersedia mengerjakan ide-ide proyek Jenkins X lainnya.

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

  • Saya sangat metodis dan terorganisir. Saya sangat berharap untuk terus mendapatkan informasi tentang progres project kepada mentor project dan komunitas organisasi melalui postingan blog seminggu sekali, rapat mingguan SIG-docs terjadwal, dan melalui email secara rutin.
  • Akan sering meminta panduan serta masukan dari mentor dan anggota komunitas, sehingga dapat menyelesaikan tugas dan memastikan semua orang berada di halaman yang sama (termasuk menyebutkan tantangan dan/atau titik pemblokiran yang dihadapi).
  • Melakukan commit semua kode sumber yang ditulis secara rutin, sehingga kode tersebut dapat ditinjau oleh mentor, kontributor, dan mendokumentasikan pekerjaan yang dilakukan sebagai referensi bagi anggota komunitas.
  • Saya memiliki semua keterampilan teknis yang diperlukan untuk mengerjakan ide project ini dan telah mendiskusikan proposal project dengan mentor Deane, Kara, dan Daniel. Saya memiliki pemahaman mendalam tentang proposal project dan hasil akhirnya.
  • Saya memiliki pengalaman dalam menggunakan keterampilan teknis (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo, dan lainnya) yang diperlukan untuk memberikan dokumentasi lengkap serta menyelesaikan sebagian besar masalah terkait dokumentasi saat ini. Saya memiliki sikap positif yang dapat menyelesaikan pekerjaan project tepat waktu dengan sedikit pengawasan.