Jenkins X projesi

Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.

Proje özeti

Açık kaynak kuruluşu:
Jenkins X
Teknik yazar:
Nitin
Projenin adı:
Mevcut Jenkins X Dokümanlar sitesini ve Jenkins X Capabilities Matrisi'ni yeniden düzenleme
Proje süresi:
Standart uzunluk (3 ay)

Proje açıklaması

Bu projenin ana hedefi, mevcut Jenkins X belgelerini yeniden düzenlemenin yanı sıra dokümanlarla ilgili sorunları düzeltmek ve güncellenmiş Jenkins X özellikleri matrisini, kurumsal bulut sağlayıcılarında Jenkins X kullanımıyla ilgili kullanıcı belgelerini hazırlamaktır. Ek olarak, bu projede Daniel ile işbirliği yaparak OpenShift tabanlı Jenkins X önizleme ortamı altyapısının geliştirilmesi üzerinde çalışmalar da yapılacak.

Mevcut Jenkins X dokümanlarını yeniden düzenlemenin bir parçası olarak, üzerinde çalışacağım sorunlardan bazıları şunlardır:

  • EKS'de Başlatma Kaynakları: Sorun
  • EKS'de Apps Kasası, Başlatma: Sorun ile başarısız oluyor
  • Jx önyüklemesi için doküman envar'ları: Sorun
  • Apps Kasası kurulumu için gerekli belgeler: Sorun
  • Yerelden kasaya yükseltme işlemi başarısız oluyor: Sorun
  • "Oluşturma", "yükleme jx", "başlatma" ve "içe aktarma" ile ilgili belgeler hakkında geri bildirim ilişkisi: Sorun
  • Miğfer Belgeleri Her Yerde: Sorun
  • ChartMuseum, Monocular ve Docker Registry'nin neden Nexus Issue ile değiştirilmediğiyle ilgili belgeleri iyileştirin
  • Boot + GKE kullanılırken Docker Registry değiştirilemiyor: Sorun
  • Alan nip.io'dan özel bir alan adına geçirilemiyor: Sorun

Jenkins X özellik Matrisi'nde, bulut sağlayıcıları (ör. Google Cloud (GKE), Amazon Web Services (AWS EKS) ve Azure Cloud (AKS).

  • Jenkins X'in diskal komut dosyaları ve jx boot aracılığıyla buluta yüklenmesi
  • Bu bulut sağlayıcılarının Kubernetes hizmetlerinde Jenkins X ile uyumlu olup olmadığı kontrol ediliyor.
  • Deane ve Jenkins X topluluğu üyeleriyle görüşülecek diğer Özellikler (gizli anahtarlar için Apps Kasası depolama alanı, Kaynak denetimi sürümleri veya diğerleri).

OpenShift'e dayalı Jenkins X önizleme ortamı altyapısının kurulumuyla ilgili çalışmalarda yapılan çalışmalar:

  • Jenkins X önizleme ortamı altyapısında OpenShift platformunda belge tasarlayın
  • OpenShift'te Jenkins X önizleme ortamlarının oluşturulmasını otomatikleştirme
  • Önizleme ortamlarında Jenkins X dokümanlarını güncelleyin

Proje Teslimatları:

  • Mevcut Jenkins X dokümanlarının yeniden düzenlenmesi dikkate alınarak, yukarıda bahsedilen doküman sorunlarına PR aracılığıyla yönelik düzeltmeler.
  • Jenkins X'i farklı bulut sağlayıcılarıyla (özellikle AKS, EKS ve GKE Kubernetes hizmetleri) kullanmayla ilgili kullanıcı belgeleriyle birlikte Jenkins X Capabilities Matrisi güncellendi.
  • Jenkins X önizleme ortamı Altyapısının Daniel ile işbirliği içinde OpenShift'e dayalı otomatik kurulumu.

Kesin Olmayan Zaman Çizelgesi (görevlerle birlikte):

Topluluk Takibi (17 Ağustos - 13 Eylül)

  • Teknik belgeler için Geliştirme ortamı oluşturun ve proje görevleri üzerinde çalışırken Cloud altyapılarına erişim kazanın.
  • Önerilen geçici takvim, proje teslimatları ve görevler (öncelikleriyle birlikte) hakkında proje danışmanlarıyla görüşmeleri.
  • Kurumun çalışma sürecini, halkla ilişkilerdeki inceleme sürecini ve toplulukla bağ kurma.
  • Jenkins X'in mevcut belgelerinin durumunu inceleyin.

1. Hafta (14-20 Eylül)

  • Jenkins X'in buluta kurulumuyla ilgili talimatları, mevcut durumu ve dokümanları inceleyin.
  • Mevcut Jenkins X özellikleri (farklı bulut sağlayıcılarında doğrulanmak üzere) hakkında Deane ile görüşme.
  • OpenShift'e dayalı Jenkins X önizleme ortamı altyapısının mevcut durumu hakkında Daniel ile yapılan tartışma.
  • OpenShift'te Jenkins X önizleme ortamı altyapısı için mimari tasarlamak üzere (Daniel ile iş birliği yaparak) çalışın.

2. Hafta (21 Eylül-27 Eylül)

  • GKE bulutu için Jenkins X özellik matrisi üzerinde çalışma: Jenkins X'i yükleme ve taslak kullanıcı notlarını hazırlama.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.

3. Hafta (28 Eylül - 4 Eki)

  • GKE bulutu için Jenkins X özellik matrisi üzerinde çalışma: Jenkins X'i yükleme ve taslak kullanıcı notlarını hazırlama.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.
  • OpenShift'e dayalı Jenkins X önizleme ortamı altyapısının Tasarım Belgesi üzerinde çalışın.

4. Hafta (5 Eki - 11 Eki)

  • GKE'de Jenkins X için kullanıcı belgelerini sonlandırın.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.

5. Hafta (12 Eki - 18 Eki)

  • Azure bulutu (AKS) için Jenkins X özellik matrisi üzerinde çalışma: Jenkins X'i yükleme ve taslak kullanıcı notlarını hazırlama.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.
  • Topluluk üyelerinden geri bildirim aldıktan sonra Jenkins X önizleme ortamı altyapısı için OpenShift'e dayalı tasarım belgesini son haline getirin.

6. Hafta (19 Eki - 25 Eki)

  • Azure bulutu (AKS) için Jenkins X özellik matrisi üzerinde çalışma: Jenkins X'i yükleme ve taslak kullanıcı notlarını hazırlama.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.

7. Hafta (26 Ekim - 1 Kasım)

  • Azure bulutu (AKS) için Jenkins X özellik matrisi üzerinde çalışma: Jenkins X'i yükleme ve taslak kullanıcı notlarını hazırlama.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.
  • Jenkins X önizleme ortamı altyapısının OpenShift'e dayalı kurulumu üzerinde çalışın.

8. Hafta (2 Kasım - 8 Kasım)

  • AKS'de Jenkins X için kullanıcı belgelerini sonlandırın.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.

9. Hafta (9 Kasım-15 Kasım)

  • AWS (EKS) için Jenkins X özellik matrisi üzerinde çalışma: Jenkins X'i yükleme ve taslak kullanıcı notlarını hazırlama.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.
  • Jenkins X önizleme ortamı altyapısının OpenShift'e dayalı kurulumu üzerinde çalışın.

10. Hafta (16 Kasım-22 Kasım)

  • AWS (EKS) için Jenkins X özellik matrisi üzerinde çalışma: Jenkins X'i yükleme ve taslak kullanıcı notlarını hazırlama.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.

11. Hafta (23 Kasım - 29 Kasım)

  • EKS'de Jenkins X için kullanıcı dokümanlarına son halini verin.
  • Mevcut Jenkins X dokümanlarını iyileştirmek için doküman sorunlarından biri üzerinde çalışın.
  • Jenkins X önizleme ortamı altyapısıyla ilgili belgeleri Jenkins X belgeleri sitesinde tamamlayın.

12. Hafta (30 Kasım-5 Aralık)

  • Proje teslimatlarını sonuçlandırmak ve varsa geri bildirime dayanarak kodu yeniden düzenlemek.
  • Bağlantılar, resimler, köprüler ve benzeri öğeler dahil olmak üzere Jenkins X dokümanlar sitesinin çalışmasını test edin.
  • Jenkins X belgeleri sitesinin kullanıcı tanımlı denetimi ve gezinme özelliğini kontrol edin.
  • Jenkins X Capabilites matrisinin son halini kontrol edin.

10 Aralık 2020'den önce Proje değerlendirmesini hem teknik yazar hem de Mentorlar gönderir.

Önerilen projenin Jenkins X ve topluluğuna ne gibi faydaları var? Bu proje, Jenkins X topluluğunun, Jenkins X teknik mimarisi, uyumluluk, kullanım ve entegrasyonu ile ilgili referans olarak geliştiricilerin yanı sıra son kullanıcıları için dokümanları iyileştirmesine yardımcı olacaktır. Önerilen bu projenin tamamlanmasıyla birlikte, farklı bulut sağlayıcılarıyla uyumluluğu için Jenkins X'in ve Jenkins X Kapasite Matrisi'nin yanı sıra tam kapsamlı, iyi tanımlanmış ve teknik olarak doğrulanmış bir kullanıcı dokümanı mevcut olacaktır.

Jenkins X ile gelecekte hangi avantajlara çalışmayı planlıyorsunuz? Google Dokümanlar Sezonu 2020 programı sona erdikten sonra topluluğun etkin bir üyesi olarak Jenkins X projesine uzun vadeli katkıda bulunmayı planlıyorum. Diğer kullanıcılara (yeniler) yardımcı olmak için her zaman yanınızda olacağım ve onları Jenkins X topluluğuna katılmaya teşvik edeceğim. Diğer Jenkins X proje fikirleri üzerinde çalışmayı her zaman isterim.

Bu projede çalışmak için beni en uygun kılan nedenlerden bazıları şunlardır:

  • Çok metodolojik ve düzenliyimdir. Haftada bir kez blog yayınları, planlanmış SIG belgeleri toplantıları ve e-postalar aracılığıyla; projenin ilerlemesi konusunda hem proje danışmanlarına hem de kurum topluluğuna bilgi vermeyi umuyorum.
  • Görevlerde ilerlemek ve herkesin aynı konuda fikir sahibi olmasını sağlamak için (karşılaşılan zorluklardan ve/veya karşılaşılan engellerden bahsetmek dahil) rehberlerden ve topluluk üyelerinden sıklıkla geri bildirim isteyecektir.
  • Kodun mentordan, katkıda bulunanlardan ve topluluk üyelerine atıfta bulunmak amacıyla yapılan çalışmaları belgelemek için yazılan kaynak kodun tamamını düzenli olarak işlemesi.
  • Bu proje fikri üzerinde çalışmak için gereken tüm teknik becerilere sahibim. Proje teklifini danışmanlar Deane, Kara ve Daniel ile görüştüm. Proje teklifi ve teslimatları hakkında derinlemesine bilgi sahibi oldum.
  • Eksiksiz bir belge sunmanın yanı sıra belgelerle ilgili mevcut sorunların çoğunu çözmek için gereken teknik beceriler (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo ve diğerleri) konusunda deneyimliyim. Az gözetim altında proje çalışmalarını zamanında tamamlayabilecek kişilere karşı olumlu bir tavır sergiliyorum.