Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- Jenkins X
- Teknik yazar:
- Nitin
- Projenin adı:
- Mevcut Jenkins X dokümanlar sitesini ve Jenkins X Özellikler Matrisi'ni yeniden düzenleme
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu projenin asıl amacı, dokümanlarla ilgili sorunları düzeltirken mevcut Jenkins X dokümanlarını yeniden yapılandırmak ve kurumsal bulut sağlayıcılarda Jenkins X kullanımıyla ilgili kullanıcı dokümanlarıyla birlikte güncellenmiş Jenkins X özellikleri matrisini hazırlamaktır. Ek olarak, bu proje, Daniel ile işbirliği içinde OpenShift tabanlı Jenkins X önizleme ortamı altyapısının geliştirilmesi üzerinde çalışmayı da içeriyor.
Mevcut Jenkins X belgelerini yeniden yapılandırmanın bir parçası olarak üzerinde çalışacağım bazı sorunlar şunlardır:
- EKS Kaynaklarında Başlatma: Sorun
- Apps Kasası, Başlatma ile EKS'de başarısız oluyor: Sorun
- jx önyüklemesi için envars dokümanı: Sorun
- Apps Kasası kurulumu için gereken dokümanlar: Sorun
- Yerelden kasada yükseltme işlemi başarısız oldu: Sorun
- Belgeler Geri Bildirimi "Oluşturma", "jx'i yükleme", "yükleme" ve "içe aktarma" arasındaki ilişki: Sorun
- Helm Dokümanları Her Yerde: Sorun
- ChartMuseum, Monocular ve Docker Registry'nin neden Nexus ile değiştirilmediğiyle ilgili dokümanları iyileştirin
- Boot + GKE kullanılırken Docker Registry değiştirilemiyor: Sorun
- nip.io alan adını özel bir alan adına değiştirme işlemi başarısız oluyor: Sorun
Jenkins X özellikleri matrisinde, çalışma aşağıdaki gibi bulut sağlayıcıların her biri tarafından sunulan kurumsal Kubernetes hizmetleri içindir: Google Cloud (GKE), Amazon Web Services (AWS EKS) ve Azure Cloud (AKS).
- Terraform komut dosyaları ve
jx boot
aracılığıyla Jenkins X'i buluta yükleme - Bu bulut sağlayıcıların Kubernetes hizmetlerinde Jenkins X ile Kubernetes sürümlerinin uyumluluğunu kontrol etme.
- Deane ve Jenkins X topluluğu üyeleri ile görüşülecek diğer tüm özellikler (gizli anahtarlar, kaynak denetimi sürümleri veya diğerleri için Apps Kasası depolama alanı).
OpenShift'e dayalı Jenkins X önizleme ortamı altyapısının ayarlanmasıyla ilgili çalışmalar şunları içerir:
- OpenShift platformunda Jenkins X önizleme ortamı altyapısıyla ilgili tasarım dokümanı
- OpenShift'te Jenkins X önizleme ortamlarının oluşturulmasını otomatikleştirme
- Önizleme ortamlarındaki Jenkins X dokümanlarını güncelleme
Proje Teslimatları:
- Mevcut Jenkins X dokümanlarını yeniden yapılandırmayı dikkate alarak yukarıda belirtilen doküman sorunlarına PR aracılığıyla düzeltmeler.
- Jenkins X'i farklı bulut sağlayıcılarla (özellikle AKS, EKS ve GKE Kubernetes hizmetleri) kullanmayla ilgili kullanıcı dokümanları ve Jenkins X Yetenekleri Matrisi güncellendi.
- Daniel ile birlikte çalışarak OpenShift tabanlı Jenkins X önizleme ortamı altyapısının otomatik olarak ayarlanması.
Önerilen kesinleşmemiş zaman çizelgesi (görevlerle birlikte):
Topluluk Bağlantısı (17 Ağustos - 13 Eylül)
- Teknik dokümanlar için geliştirme ortamı oluşturun ve proje görevlerinde çalışmak üzere Cloud altyapılarına erişin.
- Önerilen yaklaşık zaman çizelgesi, proje teslimatları ve görevlerin (öncelikleriyle birlikte) proje mentorlarıyla tartışılması.
- Kurumun çalışma sürecini ve halkla ilişkiler inceleme sürecini anlayıp tam donanımlı hale gelin ve topluluğa dahil olun.
- Jenkins X'in mevcut doküman durumunu inceleyin.
1. Hafta (14-20 Eylül)
- Bulutta Jenkins X kurulumuyla ilgili talimatları, mevcut durumu ve dokümanları inceleyin.
- Deane ile mevcut Jenkins X özellikleri hakkında yapılan görüşme (farklı bulut sağlayıcılarda doğrulanacaktır).
- OpenShift'e dayalı Jenkins X önizleme ortamı altyapısının mevcut durumu hakkında Daniel'la görüşün.
- Jenkins X'in OpenShift'te ortam altyapısının önizlemesi için mimari tasarlamak üzere (Daniel ile ortak çalışarak) çalışın.
2. Hafta (21-27 Eylül)
- GKE bulutu için Jenkins X özellik matrisi üzerinde çalışma: Jenkins X'in yüklenmesi ve kullanıcı notları taslağı hazırlanması.
- Mevcut Jenkins X dokümanlarını iyileştirmek için docs-issue konularından birinde çalışın.
3. Hafta (28 Eylül - 4 Ekim)
- GKE bulutu için Jenkins X özellik matrisi üzerinde çalışma: Jenkins X'in yüklenmesi ve kullanıcı notları taslağı hazırlanması.
- Mevcut Jenkins X dokümanlarını iyileştirmek için dokümanlardan biri üzerinde çalışın.
- OpenShift tabanlı Jenkins X önizleme ortamı altyapısı için Tasarım Dokümanı üzerinde çalışın.
4. Hafta (5-11 Ekim)
- GKE'de Jenkins X için kullanıcı dokümanlarını tamamlama.
- Mevcut Jenkins X dokümanlarını iyileştirmek için dokümanlardan biri üzerinde çalışın.
5. Hafta (12 Ekim - 18 Ekim)
- Azure bulutu (AKS) için Jenkins X özellik matrisi üzerinde çalışma: Jenkins X'in yüklenmesi ve kullanıcı notları taslağı hazırlanması.
- Mevcut Jenkins X dokümanlarını iyileştirmek için docs-issue konularından birinde çalışın.
- Topluluk üyelerinden geri bildirim aldıktan sonra Jenkins X önizleme ortamı altyapısı için OpenShift'i temel alan tasarım dokümanını tamamlayın.
6. Hafta (19 Ekim - 25 Ekim)
- Azure bulutu (AKS) için Jenkins X özellik matrisinde çalışma: Jenkins X'in yüklenmesi ve kullanıcı notları taslağı hazırlanması.
- Mevcut Jenkins X dokümanlarını iyileştirmek için docs-issue konularından birinde çalışın.
7. Hafta (26 Ekim - 1 Kasım)
- Azure bulutu (AKS) için Jenkins X özellik matrisi üzerinde çalışma: Jenkins X'in yüklenmesi ve kullanıcı notları taslağı hazırlanması.
- Mevcut Jenkins X dokümanlarını iyileştirmek için docs-issue konularından birinde çalışın.
- OpenShift'e dayalı Jenkins X önizleme ortamı altyapısını oluşturma üzerinde çalışma.
8. Hafta (2 Kasım - 8 Kasım)
- AKS'de Jenkins X için kullanıcı dokümanlarını tamamlama.
- Mevcut Jenkins X dokümanlarını iyileştirmek için docs-issue konularından birinde çalışın.
9. Hafta (9 - 15 Kasım)
- AWS (EKS) için Jenkins X özellik matrisi üzerinde çalışma: Jenkins X'in yüklenmesi ve kullanıcı notları taslağı hazırlanması.
- Mevcut Jenkins X dokümanlarını iyileştirmek için docs-issue konularından birinde çalışın.
- Jenkins X önizleme ortamının OpenShift'e dayalı olarak kurulumu üzerinde çalışın.
10. Hafta (16-22 Kasım)
- AWS (EKS) için Jenkins X özellik matrisi üzerinde çalışın: Jenkins X'in yüklenmesi ve taslak kullanıcı notları hazırlayın.
- Mevcut Jenkins X dokümanlarını iyileştirmek için dokümanlardan biri üzerinde çalışın.
11. Hafta (23 - 29 Kasım)
- EKS'de Jenkins X için kullanıcı dokümanlarını tamamlayın.
- Mevcut Jenkins X dokümanlarını iyileştirmek için dokümanlardan biri üzerinde çalışın.
- Jenkins X önizleme ortamı altyapısıyla ilgili dokümanları Jenkins X dokümanlar sitesinde tamamlayın.
12. Hafta (30 Kasım - 5 Aralık)
- Proje teslimatlarını tamamlayın ve geri bildirime göre varsa kodu yeniden yapılandırın.
- Jenkins X dokümanlar sitesinin (bağlantılar, resimler, köprüler ve diğer öğeler dahil) çalışıp çalışmadığını test edin.
- Jenkins X dokümanlar sitesinin kullanıcı tanımlı kontrolünü ve gezinme özelliklerini kontrol edin.
- Jenkins X Capabilites matrisinin son halini kontrol edin.
10 Aralık 2020'den önce Hem teknik yazarlar hem de Mentorlar proje değerlendirmesini gönderir.
Önerilen projenin Jenkins X ve topluluğu için ne gibi faydaları var? Bu proje, Jenkins X topluluğunun hem son kullanıcıları hem de geliştiriciler için Jenkins X teknik mimarisi, uyumluluğu, kullanımı ve entegrasyonu hakkında referans olarak kullanabilecekleri dokümanları iyileştirmesine yardımcı olacaktır. Önerilen bu projenin tamamlanmasıyla birlikte, farklı bulut sağlayıcılarla uyumluluğu için Jenkins X Yetenek Matrisi ile birlikte Jenkins X'in tam teşekküllü, iyi tanımlanmış ve teknik olarak doğrulanmış bir kullanıcı dokümanı oluşturulacaktır.
Jenkins X ile gelecekte hangi avantajlar üzerinde çalışmayı planlıyorsunuz? Google Dokümanlar 2020 Sezonu programı sona erdikten sonra, topluluğun etkin bir üyesi olarak Jenkins X projesine uzun vadeli katkıda bulunan bir kişi olmayı planlıyorum. Yeni gelenlere yardımcı olmak ve onları Jenkins X topluluğuna katılmaya teşvik etmek için her zaman hazırım. Diğer Jenkins X proje fikirleri üzerinde çalışmaktan her zaman memnuniyet duyarım.
Bu projede çalışmak için en uygun kişi olmamı sağlayan bazı nedenler:
- Çok metodik ve düzenliyim. Projenin ilerleme durumu hakkında hem proje mentorlarını hem de kuruluş topluluğunu haftada bir blog yayını, planlanmış SIG-docs haftalık toplantıları ve düzenli olarak e-posta göndererek bilgilendirmenizi bekliyoruz.
- Görevlerde ilerlemek ve herkesin aynı fikirde olmasını sağlamak için (karşılaşılan zorluklardan ve/veya engelleme noktalarından bahsederek) mentorlardan ve topluluk üyelerinden sık sık rehberlik ve geri bildirim isteyecek.
- Yazılan tüm kaynak kodları düzenli olarak göndererek kodları mentor ve katkıda bulunanların incelemesine sunmak ve topluluk üyelerinin referans olarak kullanabileceği çalışmaları belgelemek.
- Bu proje fikri üzerinde çalışmak için gereken tüm teknik becerilere sahibim ve proje teklifi hakkında danışmanlar Deane, Kara ve Daniel’la görüştüm. Proje teklifini ve teslimatlarını ayrıntılı olarak anladım.
- Tam teşekküllü bir doküman sağlamak ve mevcut dokümanlarla ilgili sorunların çoğunu çözmek için gereken teknik becerilerle (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo ve diğerleri) çalışma konusunda deneyimliyim. Proje çalışmalarını az miktarda gözetimle zamanında tamamlayabilecek, olumlu ve her şeyin üstesinden gelebilecek bir tavra sahibim.