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:
- Apache Flink
- Teknik yazar:
- haseeb1431
- Projenin adı:
- Apache Flink için Table API ve SQL Dokümanları'nın Genişletilmesi
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
"Tablo API'sini ve SQL belgelerini genişletme" konulu GSOD başvurumu gönderiyorum. API dokümanlarını, büyükannelerin de sorgu yazabileceği şekilde yazacağız. Yapıya zaten sahip olabiliriz ancak yeni başlayan kullanıcılar olarak bu yapıyı inceleyip gerektiğinde fikirler önereceğiz. Düşünme süreçlerini anlamak için mentorlarla yakın bir şekilde çalışarak sektördeki önceki deneyimlerime dayalı farklı fikirler paylaşmayı planlıyorum.
Mevcut belgelere dayanarak aldığımız ilk görüşlerden bazıları:
Genel bakış sayfasında şu anda çok fazla bilgi var ancak hem yeni başlayan hem de ileri düzey kullanıcıların hızlı bir şekilde başlayabileceği şekilde yeniden ziyaret edilip düzenlenmesi gerekiyor. Farklı olası başlangıç yolları sunmak istiyorum: a) Yeni bir proje başlatıp sorguları bunun üzerinde çalıştırma, b) Mevcut bir projenin üzerinde SQL veya Table API sorguları çalıştırma.
Ayrıca, kullanıcıların tüm olasılıkları ilk bakışta görebilmesi için açılış sayfasında API dokümanlarının tam bir haritasına ihtiyacımız var. Bu bölüm, mevcut genel bakış sayfasındaki "Sonraki adımlar" bölümünün iyileştirilmiş bir sürümü olacaktır.
Kavram sayfasında oldukça iyi içerikler var ancak tek bir sayfaya çok fazla şey sığdırılmış. Bu nedenle, bu sayfada birkaç alt bölüm olacak. Benzer şekilde, Planlayıcılar, Yerleşik işlevler ve Bağlantıcılar gibi diğer bölümlerin genel bakış sayfasında veya sol gezinme çubuğunda daha görünür olması gerekir. Bağlayıcılar sayfası, bağlayıcılar ve biçimler gibi daha fazla alt bölüme ayrılabilir. Tek bir sayfada mümkün olan tüm yöntemlere sahip olduğumuzdan ve kullanıcılar bunları her zaman yardımcı kısa bilgiler olarak değerlendirebildiğinden, sistem (Yerleşik) işlevleri bana uygun görünüyor ancak bunlarla ilgili daha fazla içerik eklemekten memnuniyet duyacaklar.
Bu üç aylık dönem farklı aşamalara ayrılacaktır. Başlangıçta Table &SQL API belgelerinin site haritası gibi bir yapısını oluşturacağız. Yukarıda paylaşıldığı gibi alt bölümler ve hikaye hatları sunacağız. Program tamamlandıktan sonra, hem deneyimli hem de başlangıç seviyesindeki kullanıcılar tarafından incelenmesini sağlayabiliriz. Öte yandan, geri bildirimi beklerken planlayıcılar ve bağlayıcılar hakkında yazmaya başlayabiliriz. Geri bildirim aldıktan sonra API dokümanlarımızı yeniden yapılandıracağız. Ardından, bekleyen bölümlerin yazımını tamamlamaya odaklanacağız. Son olarak, zaman izin verirse sıfırdan bir örnek alıp FLINK-12639 için yararlanılabilecek uçtan uca proje uygulamasını göstermeyi planlıyorum.
2 hafta sonra Slack'taki (veya başka araçlardaki) sohbetler dışında bir saatlik toplantı yapmayı öneriyorum. Projenin gidişatını her hafta takip etmemize yardımcı olmak için projenin başlangıç takvimini ve beklenen haftaları paylaşacağım.
Son olarak, bu doküman, Flink API'nin farklı işlevlerini öğrenirken kullandığımız tüm temel ayrıntıları eklediğimiz medium.com adresindeki blogumuza benzer. Yalnızca teknik belgeler yazmak yerine belgeleri uygulamalı olarak doğruladığım için bu yöntem beni benzersiz bir aday haline getiriyor. Tablo ve SQL API'yi öğrenirken açık kaynak dokümantasyonuna katkıda bulunacağım için bu proje benim için iki ucu keskin bir kılıç gibi olacak.