Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan proyek
- Organisasi open source:
- Apache Flink
- Penulis teknis:
- haseeb1431
- Nama project:
- Ekstensi Dokumentasi SQL & Table API untuk Apache Flink
- Durasi project:
- Durasi standar (3 bulan)
Project description
Saya mengirimkan permohonan untuk GSOD tentang “Memperluas Table API & Dokumentasi SQL”. Kita akan menulis dokumentasi API sehingga nenek juga dapat menulis kueri. Meskipun kami mungkin sudah memiliki struktur tersebut, kami akan memeriksanya sebagai pengguna baru dan menyarankan ide jika diperlukan. Saya berencana untuk bekerja sama dengan mentor untuk memahami proses pemikiran mereka sambil berbagi ide yang berbeda berdasarkan pengalaman saya di industri sebelumnya.
Beberapa pemikiran awal berdasarkan dokumentasi saat ini adalah:
Halaman ringkasan saat ini berisi banyak informasi, tetapi perlu ditinjau dan diurutkan sedemikian rupa sehingga pengguna pemula dan lanjutan dapat memulai dengan cepat. Ide saya adalah memulai dengan berbagai kemungkinan jalur, a) memulai project baru, lalu menjalankan kueri di atasnya, b) menjalankan kueri SQL atau Table API di atas project yang ada.
Kita juga perlu memiliki peta lengkap dokumentasi API di halaman landing sehingga pengguna dapat melihat semua kemungkinan pada pandangan pertama. Bagian ini akan menjadi versi yang lebih baik dari bagian “Ke mana harus melanjutkan” di halaman ringkasan saat ini.
Halaman konsep memiliki konten yang cukup bagus, tetapi terlalu banyak dipadatkan ke dalam satu halaman sehingga kita akan memiliki beberapa subbagian di halaman ini. Demikian pula, bagian lain seperti Perencana, Fungsi bawaan, Konektor memerlukan visibilitas yang lebih baik, mungkin di halaman ringkasan atau menu navigasi sebelah kiri. Halaman konektor dapat dibagi menjadi subbagian lainnya, misalnya konektor, format, dan sebagainya. Fungsi Sistem (Terintegrasi) terlihat bagus bagi saya karena kami memiliki semua metode yang mungkin tersedia di satu halaman dan pengguna dapat merujuknya sebagai lembar catatan kapan saja, tetapi kami akan dengan senang hati menambahkan lebih banyak konten terkait hal tersebut.
Periode tiga bulan akan dibagi menjadi beberapa fase. Awalnya, kita akan membuat struktur, seperti peta situs, dari dokumentasi Table & SQL API. Kita akan memperkenalkan subbagian dan memperkenalkan alur cerita seperti yang dibagikan di atas. Setelah selesai, kita dapat meninjaunya dengan pengguna tingkat lanjut dan pemula. Di sisi lain, kita dapat mulai menulis tentang perencana, konektor sambil menunggu masukan. Setelah menerima masukan, kami akan menyusun ulang dokumen API. Selanjutnya, kita akan fokus menyelesaikan penulisan untuk bagian yang tertunda. Akhirnya, jika waktu memungkinkan, saya berencana untuk mengambil contoh dari awal dan menunjukkan implementasi proyek yang menyeluruh dan dapat dimanfaatkan untuk FLINK-12639.
Saya mengusulkan agar kita dapat mengadakan rapat selama satu jam setelah 2 minggu, selain chat di Slack (atau alat lainnya). Saya akan membagikan linimasa project awal dengan perkiraan minggu yang akan membantu kita melacak progres project setiap minggu.
Terakhir, dokumentasi ini mirip dengan blog kami di medium.com tempat kami menambahkan semua detail dasar saat mempelajari berbagai fungsi Flink API. Hal ini juga menjadikan saya kandidat yang unik karena saya akan memverifikasi dokumentasi dengan penerapan langsung, bukan hanya menulis dokumen teknis. Project ini akan berfungsi sebagai pedang ganda bagi saya karena saya akan berkontribusi pada dokumentasi open source sambil mempelajari Tabel dan SQL API.