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:
- Bulutta Yerel Bilişim Vakfı (CNCF)
- Teknik yazar:
- Semra Sundar K
- Projenin adı:
- Daha Fazla ve Daha İyi Kubectl Örnekleri
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Bu projenin amacı mevcut kubectl kısa notlarını ve referans belgeleri geliştirmektir.
Bu projenin nihai hedefleri şunlardır: • Daha fazla ve daha iyi kubectl örnekleri oluşturun. • kubectl ile ilgili yardımcı kısa bilgilere kubectl örnekleri ekleyin. • Maksimum düzeyde yardım sağlamak için kubectl dokümanlarını yeniden düzenleyin.
Hedef I - kubectl örnekleri:
Kubernetes kullanıcılarının en çok ne tür örnekleri görmek istedikleri ve bunu belgeleme konusunda bağlamı anlamak için KSA özel ilgi gruplarıyla yakın işbirliği içinde çalışacağız. Bu bilgiler yardımcı kısa bilgilerdeki mevcut kubectl komutlarını iyileştirmekten yardımcı kısa bilgilere yeni komutlar eklemeye kadar değişiklik gösterebilir.
Hedef II - Dokümanların Daha Çok Yardımcı Olması:
Dokümanların daha yararlı olması için aşağıdakiler yapılabilir:
• Yeni başlayanların zorluklarını ortadan kaldırma • Mantıksal akışta sürekliliği sağlamak için kubectl komutunu belirli bir sıraya göre yeniden düzenleme
Daha iyi komut / kullanıcı senaryosu açıklamalarıyla yeni başlayanların zorluklarını ortadan kaldırın. Bu yöntem basit gibi görünse de yeni başlayanların öğrenmeye devam etmesini veya öğrenmeyi bırakmasını önemli ölçüde etkileyebilir. Örneğin, kubectl ile Kubernetes'i kullanmaya başladığımda kapsüller ve dağıtımlar arasındaki farklardan emin değildim. İlk başta Nodejs'de yazılmış bir arka uç hizmeti dağıttım. Birkaç saat sonra kapatmak istedim ve kapsülü silmeyi denedim. Ancak kapsüllerin kendiliğinden iyileşen doğası nedeniyle tekrar oluşturuldular. Neler olduğu konusunda şaşkınım ve bunun neden yeniden oluşturulup silinmediğini merak ediyordum. Web'de birkaç arama yaptıktan sonra, kapsülleri silmenin dağıtım silmekle aynı şey olmadığını gördüm. Eğitimli bir göz için bu basit görünebilir, ancak iyi bir dokümanı harika bir dokümandan ayıran, bu tür belirsizlikleri ortadan kaldıran net bir açıklamadır.
Mantıksal akışta sürekliliği sağlamak için kubectl komutunu belirli bir sırada yeniden düzenleme. Benim gibi hikaye anlatımına inancı olan biriyseniz muhtemelen merak edeceksiniz, terminal komutları listesi içeren bir doküman sayfasına hikaye anlatımı öğelerini nasıl yerleştirebileceğinizi. Öğrendiğimiz her şeyin mantıksal bir akışı vardır. Sizce bu bir başlangıç ve bir bitiş noktasıdır. Komut satırı aracı olarak Kubectl'in elbette bir öğrenme eğrisi var. Hatta öğrenme eğrisi Kubernetes'in kendi öğrenme eğrisiyle örtüşüyor. Neredeyse herkes yolculuğuna kubectl üzerinden kubernetes ile başladığından (web kullanıcı arayüzünü kullananlar hariç) ve öğrenme eğrisi Kubernetes'lerin öğrenme eğrisiyle yakından ilişkili olduğundan Dokümanlar yalnızca bu komutların sırasını değiştirip hikaye anlatma öğeleri ekleyerek çok daha iyi hale getirilebilir. Örneğin, yatay kapsül otomatik ölçeklendirme gibi özelliklerin gerçek hayattan örnekler ve resimlerle kaynaklar açıklandıktan sonra açıklanabileceğini düşünelim.
Hedef III - Dokümanlar Kullanılabilirliğiyle İlgili İyileştirmeler:
Kubernetes web sitesinin Dokümanlary Hugo'ya yakın zamanda taşınması olağanüstü bir gelişme ve dokümanlar açısından muazzam bir değişim. Taşıma başarılı olsa da, doküman alanında halen birçok iyileştirme yapılabilir.
İşte size önerdiğim bazı değişiklikler,
• Sol bölmede, ana dokümanlardaki şu anda etkin olan bölüme otomatik olarak gidin. Bu seçenek, mevcut, gelecek ve geçmiş bölümlerin takibinde yardımcı olabilir. • Panoya kopyala - Bazı komutlar uzun olabilir, bu tür komutlarla çalışırken kopyalama işlevi yararlı olabilir. • Doküman dosyalarının İçerik Biçimlendirmesi - Taşıma işleminden sonra, birkaç sayfadaki içerik uygun şekilde biçimlendirilmemiştir. Örneğin: kubectl genel bakışındaki Kaynak Türü bölümü. Bu, kullanıcı deneyimini kötüleştirir.
Bunlar, Kubernetes web sitesinde kullanıcı deneyimini geliştirebilecek ve kullanıcı üretkenliğini de artırabilecek değişikliklerdir.