تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- Apache Flink
- الكاتب التقني:
- haseeb1431
- اسم المشروع:
- إضافة إلى مستندات Table API وSQL لـ Apache Flink
- مدة المشروع:
- مدة زمنية عادية (3 أشهر)
وصف المشروع
أُرسل طلبي للحصول على جائزة GSOD بشأن "توسيع نطاق Table API ووثائق SQL". سنكتب مستندات واجهة برمجة التطبيقات حتى تتمكّن الجدة من كتابة طلبات البحث أيضًا. على الرغم من أنّنا قد نمتلك البنية، إلا أنّنا سنراجعها بصفتنا مستخدمين مبتدئين ونقدّم أفكارًا عند الحاجة. أخطّط للعمل عن كثب مع المرشدين لفهم أسلوب تفكيرهم أثناء مشاركة أفكار مختلفة استنادًا إلى خبرتي السابقة في المجال.
بعض الأفكار الأولية بناءً على الوثائق الحالية هي:
تحتوي صفحة "النظرة العامة" حاليًا على الكثير من المعلومات ولكن يجب إعادة النظر فيها وترتيبها بطريقة يمكن للمستخدم المبتدئ والمتقدم البدء بسرعة. أريد أن أقدّم مسارَين مختلفَين للبدء، هما: أ) بدء مشروع جديد ثمّ تنفيذ طلبات البحث عليه، ب) تنفيذ طلبات بحث SQL أو Table API على مشروع حالي.
نحتاج أيضًا إلى الحصول على خريطة كاملة لمستندات واجهة برمجة التطبيقات على الصفحة المقصودة حتى يتمكّن المستخدمون من الاطّلاع على جميع الاحتمالات من النظرة الأولى. سيكون هذا القسم نسخة محسّنة من قسم "الأماكن التي يمكنك الانتقال إليها بعد ذلك" في صفحة النظرة العامة الحالية.
تحتوي صفحة المفهوم على محتوى جيد جدًا، ولكنّه مكثّف جدًا في صفحة واحدة، لذا سنضيف بعض الأقسام الفرعية في هذه الصفحة. وبالمثل، تحتاج الأقسام الأخرى، مثل "المخطّطون" و"الدوالّ المضمّنة" و"العناصر الرابطة"، إلى مزيد من الظهور، ربما في صفحة النظرة العامة أو شريط التنقّل الأيمن. يمكن تقسيم صفحة "الموصّلات" إلى المزيد من الأقسام الفرعية، مثل الموصّلات والتنسيقات وما إلى ذلك. أرى أنّ الدوالّ النظامية (المضمّنة) جيدة لأنّنا نوفّر جميع الطرق الممكنة في صفحة واحدة ويمكن للمستخدمين الرجوع إليها كجداول تلخيصية في كلّ وقت، ولكن سيسرّنا إضافة المزيد من المحتوى حول ذلك.
ستنقسم فترة الأشهر الثلاثة إلى مراحل مختلفة. في البداية، سننشئ بنية، مثل خريطة موقع، لمستندات Table & SQL API. وسنقدم أقسامًا فرعية وسنعرض أسطر القصة كما هو موضح أعلاه. بعد اكتمالها، يمكننا مراجعتها مع المستخدمين المتقدّمين والمبتدئين. من ناحية أخرى، يمكننا البدء في الكتابة عن المخططين والموصلات أثناء انتظارنا الملاحظات. بعد تلقّي الملاحظات، سنعيد تنظيم مستندات واجهة برمجة التطبيقات. بعد ذلك، سنركز على إنهاء الكتابة للأقسام قيد المراجعة. وأخيرًا، إذا كان الوقت مسموحًا به، أخطط لأخذ مثال من البداية وعرض حالة تنفيذ المشروع من البداية إلى النهاية والذي يمكن الاستفادة منه في FLINK-12639.
نقترح عقد اجتماع لمدة ساعة بعد أسبوعين غير المحادثات على Slack (أو أي أدوات أخرى). سأشارك معك مخططًا زمنيًا أوليًا للمشروع يتضمّن الأسابيع المتوقّعة، ما سيساعدنا في تتبُّع مستوى تقدّم المشروع أسبوعيًا أيضًا.
أخيرًا، تتشابه هذه المستندات مع مدونتنا على medium.com حيث نضيف جميع التفاصيل الأساسية عند تعلُّم الوظائف المختلفة لواجهة برمجة التطبيقات Flink API. ويجعلني ذلك أيضًا مرشحًا فريدًا لأنّني سأتحقّق من المستندات من خلال عمليات التنفيذ العملية بدلاً من مجرد كتابة المستندات الفنية. سيعمل هذا المشروع بمثابة سيف مزدوج بالنسبة لي حيث سأساهم في الوثائق مفتوحة المصدر أثناء تعلم الجدول وواجهة برمجة تطبيقات SQL.