בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- Apache Flink
- כותבים טכניים:
- haseeb1431
- שם הפרויקט:
- הרחבה של Table API ושל מסמכי התיעוד של SQL ל-Apache Flink
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
אני שולחת את הבקשה שלי ל-GSOD בנושא 'הרחבת Table API ותיעוד SQL'. נכתוב תיעוד API כדי שגם סבתא תוכל לכתוב שאילתות. יכול להיות שכבר יש לנו את המבנה, אבל נעבור עליו כמשתמשים מתחילים ונציע רעיונות בכל מקום שבו נדרשים. אני מתכנן לעבוד בשיתוף פעולה הדוק עם מנטורים כדי להבין את תהליך החשיבה שלהם ולשתף רעיונות שונים המבוססים על הניסיון הקודם שלי בתחום.
חלק מהרעיונות הראשוניים על סמך התיעוד הנוכחי הם:
דף הסקירה הכללית מכיל כרגע מידע רב, אבל צריך לחזור אליו ולסדר אותו כך שגם משתמש מתחיל וגם מתקדם יוכלו להתחיל במהירות. הרעיון שלי הוא ליצור מדריך למתחילים עם מסלולים שונים אפשריים: א) התחלת פרויקט חדש ואז הפעלת השאילתות מעליו, ב) הפעלת שאילתות SQL או Table API מעל פרויקט קיים.
בנוסף, אנחנו צריכים להציג בדף הנחיתה מפה מלאה של מסמכי התיעוד של ה-API, כדי שמשתמשים יוכלו לראות את כל האפשרויות במבט מהיר. זה יהיה גרסה משופרת של הקטע 'מה עושים עכשיו?' בדף הסקירה הכללית הנוכחי.
בדף הקונספט יש תוכן טוב למדי, אבל הוא דחוס מדי בדף אחד, לכן נוסיף כמה קטעים משניים בדף הזה. באופן דומה, יש צורך להגדיל את החשיפה של קטעים אחרים, כמו 'תכנונים', 'פונקציות מובנות' ו'חיבורים', אולי בדף הסקירה הכללית או בסרגל הניווט הימני. אפשר לחלק את הדף 'מחברים' לקטעים משנה נוספים, למשל מחברים, פורמטים וכו'. הפונקציות המערכתיות (המובנות) נראות לי בסדר, כי כל השיטות האפשריות זמינות בדף אחד והמשתמשים יכולים להיעזר בהן תמיד כגיליונות עזר, אבל אשמח להוסיף תוכן נוסף בנושא.
תקופת שלושת החודשים תהיה מחולקת לשלבים שונים. בשלב הראשון, ניצור מבנה, כמו sitemap, של מסמכי העזרה של Table API ו-SQL API. נציג קטעי משנה ונציג את שורות הסיפור כפי ששותפו למעלה. לאחר השלמתו, נוכל לבדוק אותו עם משתמשים מתחילים ומתחילים. מצד שני, אנחנו יכולים להתחיל לכתוב על התכנונים והחיבורים בזמן שאנחנו ממתינים למשוב. אחרי שנקבל את המשוב, נבנה מחדש את מסמכי ה-API שלנו. בשלב הבא נתמקד בהשלמת הכתיבה של החלקים שעדיין לא הספקנו לכתוב. לבסוף, אם יש לי זמן, בכוונתי לקחת דוגמה מאפס ולהציג את תהליך ההטמעה של פרויקט מקצה לקצה כדי שתוכלו להשתמש בו עבור FLINK-12639.
אני מציע שנוכל לקיים פגישה של שעה אחרי שבועיים, מלבד צ'אטים ב-Slack (או בכלים אחרים). גם אשלח לכם לוח זמנים ראשוני לפרויקט עם השבועות הצפויים. כך נוכל לעקוב גם אחרי התקדמות הפרויקט מדי שבוע.
לסיום, המסמך הזה דומה לבלוג שלנו ב-medium.com, שבו אנחנו מוסיפים את כל הפרטים הבסיסיים כשאנחנו לומדים פונקציות שונות של Flink API. בנוסף, הניסיון הזה הופך אותי למועמד ייחודי, כי אוכל לאמת את המסמכים באמצעות הטמעות מעשיות במקום רק לכתוב את המסמכים הטכניים. הפרויקט הזה ישמש בתור 'חרב כפולה', כי אני אשתמש במסמכי התיעוד בקוד פתוח בזמן הלמידה של Table ו-SQL API.