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:
- Cloud Native Computing Foundation (CNCF)
- Teknik yazar:
- Syam Sundar K
- Projenin adı:
- Daha Fazla ve Daha İyi Kubectl Örnekleri
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu projenin amacı, mevcut kubectl hızlı referans kılavuzunu ve referans dokümanlarını iyileştirmektir.
Bu projenin nihai hedefleri şunlardır: • Daha fazla ve daha iyi kubectl örnekleri oluşturma. • kubectl örneklerini kubectl hızlı referans kılavuzuna ekleyin. • En fazla faydayı sağlamak için kubectl dokümanlarını yeniden yapılandırın.
Hedef I - kubectl örnekleri:
Kubernetes kullanıcılarının en çok hangi tür örnekleri istediğini anlamak ve bunları belgelemek için CLI özel ilgi gruplarıyla yakın bir şekilde çalışacağız. Bu, hızlı referans sayfasındaki mevcut kubectl komutlarını iyileştirmekten hızlı referans sayfasına yeni komutlar eklemeye kadar çeşitlilik gösterebilir.
II. Hedef: Dokümanların faydasını artırma:
Dokümanların faydasını artırmak için aşağıdakiler yapılabilir:
• Yeni başlayanların yaşadığı zorlukları ortadan kaldırın • Mantıksal akışın devamlılığını sağlamak için kubectl komutunu belirli bir sırada yeniden düzenleyin
Daha iyi komut / kullanıcı durumu açıklamaları sayesinde yeni başlayanların yaşadığı zorlukları ortadan kaldırın. Bu basit bir yöntem gibi görünse de, yeni başlayanların öğrenmeye devam etmelerini veya öğrenmelerini önemli ölçüde etkileyebilir. Örneğin, kubectl aracılığıyla Kubernetes kullanmaya başladığımda kapsüller ve dağıtımlar arasındaki farklardan emin olmadığımı varsayalım. Başlangıçta nodejs ile yazılmış bir arka uç hizmeti dağıttım. Birkaç saat sonra pod'u kapatmak istediğim için silmeyi denedim ancak pod'ların kendi kendini iyileştirme özelliği nedeniyle pod'lar tekrar oluşturuldu. Neler olduğunu anlayamıyordum ve neden silinmeyip yeniden oluşturulduğunu merak ediyordum. Web'de birkaç arama yaptıktan sonra kapsülleri silmenin, dağıtımı silmekle aynı olmadığını anladım. Bu, eğitimli bir göz için basit görünebilir ancak bu tür belirsizlikleri ortadan kaldıran net bir açıklama, iyi bir dokümanı mükemmel bir dokümandan ayıran şeydir.
Mantıksal akışta devamlılık sağlamak için kubectl komutunu belirli bir sırada yeniden düzenleme. Benim gibi hikaye anlatmayı çok önemseyen biriyseniz hikaye anlatma öğelerini, terminal komutlarının listesini içeren bir doküman sayfasına nasıl ekleyeceğinizi merak ediyor olabilirsiniz. Bu işlem yapılabilir. Öğrendiğimiz her şeyin mantıklı bir akışı vardır. Bir başlangıç ve bitiş noktası vardır. Kubectl komut satırı aracı olarak elbette bir öğrenme eğrisine sahip. Hatta öğrenme eğrisi, Kubernetes'in öğrenme eğrisiyle örtüşüyor. Hemen hemen herkes kubernetes yolculuğunu kubectl üzerinden başlattığından (web kullanıcı arayüzünü kullananlar hariç) ve öğrenme eğrisi kubernetes'in öğrenme eğrisine sıkı sıkıya bağlı olduğundan, dokümanlar yalnızca bu komutların sırasını değiştirerek ve hikaye anlatma öğeleri ekleyerek önemli ölçüde iyileştirilebilir. Örneğin, yatay kapsül otomatik ölçeklendirme gibi özellikler, kaynaklar açıklandıktan sonra gerçek hayattan örnekler ve görsellerle açıklanabilir.
III. Hedef: Dokümanlar'da Kullanılabilirlik İyileştirmeleri:
Kubernetes web sitesinin Docsy Hugo'ya taşınması harika bir gelişme ve doküman perspektifinde büyük bir değişim. Taşıma işlemi başarılı olsa da doküman alanında daha birçok iyileştirme yapılabilir.
Size önerdiğim değişikliklerden bazıları şunlardır:
• Sol bölmede, ana dokümanlarda o anda etkin olan bölüme otomatik olarak kaydırılır. Bu, mevcut, gelecek ve geçmiş bölümleri takip etmenize yardımcı olabilir. • Panoya kopyala: Bazı komutlar uzun olabilir. Bu tür komutlarla çalışırken kopyalama işlevi yararlı olabilir. • doc dosyalarının içerik biçimlendirmesi: Taşıma işleminden sonra birkaç sayfadaki içerikler düzgün şekilde biçimlendirilmiyor. Ör. kubectl'e genel bakıştaki Kaynak Türü bölümü. Bu durum, kullanıcı deneyimini olumsuz etkiler.
Bunlar, Kubernetes web sitesindeki kullanıcı deneyimini iyileştirebilecek ve kullanıcı verimliliğini artırabilecek değişikliklerdir.