این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- آپاچی فلینک
- نویسنده فنی:
- haseeb1431
- نام پروژه:
- گسترش جدول API و اسناد SQL برای Apache Flink
- طول پروژه:
- طول استاندارد (3 ماه)
شرح پروژه
من درخواست خود را برای GSOD در "توسعه جدول API & SQL Documentation" ارسال می کنم. ما اسناد API را طوری می نویسیم که مادربزرگ بتواند پرس و جو بنویسد. اگرچه، ممکن است ما قبلاً ساختار را داشته باشیم، اما به عنوان کاربران تازه کار از آن عبور خواهیم کرد و هر جا که لازم باشد ایده هایی را پیشنهاد می کنیم. من قصد دارم از نزدیک با مربیان کار کنم تا فرآیند فکر آنها را درک کنم و در عین حال ایده های مختلف را بر اساس تجربه قبلی خود در صنعت به اشتراک بگذارم.
برخی از افکار اولیه بر اساس اسناد فعلی عبارتند از:
صفحه نمای کلی در حال حاضر اطلاعات زیادی دارد، اما نیاز به بازبینی و سفارش به روشی دارد که کاربر مبتدی و پیشرفته هر دو بتوانند به سرعت شروع به کار کنند. ایده من این است که شروعی با مسیرهای مختلف ممکن داشته باشم، الف) شروع یک پروژه جدید و سپس اجرای پرس و جوها در بالای آن، ب) اجرای پرس و جوهای SQL یا Table API در بالای پروژه موجود.
همچنین باید یک نقشه کامل از اسناد API در صفحه فرود داشته باشیم تا کاربران بتوانند در نگاه اول همه احتمالات را ببینند. این یک نسخه بهبود یافته از بخش «بعدی کجا برویم» در صفحه نمای کلی فعلی خواهد بود.
صفحه مفهومی محتوای بسیار خوبی دارد اما بیش از حد در یک صفحه فشرده است، بنابراین ما زیربخش های کمی در این صفحه خواهیم داشت. به طور مشابه، بخشهای دیگر برنامهریزان، توابع داخلی، اتصالدهندهها ممکن است در صفحه نمای کلی یا نوار ناوبری سمت چپ به دید بیشتری نیاز داشته باشند. صفحه اتصال دهنده ها را می توان به بخش های فرعی بیشتری به عنوان مثال اتصال دهنده ها، فرمت ها و غیره تقسیم کرد. عملکردهای سیستم (ساختشده) به نظر من خوب به نظر میرسند، زیرا همه روشهای ممکن را در یک صفحه در دسترس داریم و کاربران میتوانند همیشه به آنها به عنوان برگههای تقلب اشاره کنند، اما خوشحال میشوند که محتوای بیشتری در این زمینه اضافه کنند.
دوره سه ماهه به مراحل مختلف تقسیم می شود. در ابتدا، ساختاری مانند نقشه سایت از اسناد Table & SQL API ایجاد خواهیم کرد. ما بخشهای فرعی را معرفی میکنیم و خطوط داستانی را همانطور که در بالا به اشتراک گذاشته شد، معرفی میکنیم. پس از تکمیل، میتوانیم آن را با کاربران سطح پیشرفته و مبتدی بررسی کنیم. از سوی دیگر، می توانیم در حالی که منتظر بازخورد هستیم، شروع به نوشتن در مورد برنامه ریزان، رابط ها کنیم. پس از دریافت بازخورد، اسناد API خود را بازسازی خواهیم کرد. در مرحله بعد، ما روی تکمیل نوشتن برای بخش های در انتظار تمرکز خواهیم کرد. در نهایت، اگر زمان اجازه داده شود، من قصد دارم از ابتدا مثالی بزنم و اجرای پروژه را از ابتدا به نمایش بگذارم که می تواند برای FLINK-12639 استفاده شود.
من پیشنهاد می کنم که ما می توانیم بعد از 2 هفته یک جلسه یک ساعته داشته باشیم به غیر از چت در حالت شل (یا هر ابزار دیگری). من جدول زمانی اولیه پروژه را با هفته های مورد انتظار به اشتراک می گذارم که به ما کمک می کند پیشرفت پروژه را به صورت هفتگی نیز پیگیری کنیم.
در نهایت، این مستندات مشابه وبلاگ ما در medium.com است که در آن هنگام یادگیری عملکردهای مختلف Flink API، همه جزئیات اولیه را اضافه می کنیم. همچنین من را به یک کاندیدای منحصربفرد تبدیل می کند، زیرا به جای نوشتن اسناد فنی، اسناد را با پیاده سازی های عملی تأیید می کنم. این پروژه به عنوان یک شمشیر دوگانه برای من کار خواهد کرد زیرا در حین یادگیری جدول و SQL API به اسناد منبع باز کمک خواهم کرد.