בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון בקוד פתוח:
- DVC
- כותבים טכניים:
- imhardikj
- שם הפרויקט:
- הטמעת מדריכים בקטע 'איך עושים את זה' ועדכון מסמכי DVC 1.0
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
אחת המטרות של הפרויקט היא להטמיע את הסעיף "How To" (הדרכה) שמתייחס בפירוט לשאלות הנפוצות הקשורות ל-DVC. המטרה הבאה היא לעדכן את המסמכים בהתאם לגרסה האחרונה של DVC 1.x. יש שינויים משמעותיים בהשוואה לגרסאות הקודמות, ולכן יש צורך לעדכן את המסמכים לגרסה האחרונה. לאחר מכן, המשימות הבאות יתבססו על העדיפויות של DVC במהלך תקופת הכתיבה.
יעדי הפרויקט:
1) כמה דוגמאות לקטע 'איך עושים את זה': - איך ""לבטל"" את הפקודה 'dvc add' (איך לבטל שגיאות). - איך מוסיפים יחסי תלות חסרים לצינור עיבוד נתונים קיים. - איך משתמשים ב-DVC כשהנתונים מאוחסנים בכונן חיצוני (מדריך לניהול נתונים חיצוניים).
אלה כמה מהרעיונות שמבוססים על הבעיה ב-GitHub (github.com/iterative/dvc.org/issues/899) שאפשר לכלול בקטע הזה. במסגרת השינוי, חלק מהמסמכים הקיימים (למשל, 'הפעלת DVC ב-Windows') יועברו לקטע הזה. אם יעד הדרכה לא מתאים לקטע הזה, אפשר לעדכן אותו בקובץ העזר של הפקודה (או בתיעוד הרלוונטי) ולצרף דוגמה. אפשר להרחיב את הקטע הזה ולכלול בו הדרכות נוספות בכל פעם שאני נתקל בהן בערוצים קהילתיים.
2) החלק המשמעותי השני בפרויקט הזה הוא עדכון המסמכים עכשיו, אחרי שגרסת DVC 1.0 שוחררה (dvc.org/blog/dvc-1-0-release), ובהתאם לעדכונים רלוונטיים אחרים שעשויים להתפרסם עד ספטמבר. המסמכים (כל הפניות הפקודות וכו') אמורים להתעדכן בהתאם לשינויים האלה, חלק מהם מוזכרים בבעיה הזו (github.com/iterative/dvc.org/issues/1255).
3) אוכל גם לעבוד על עדכון של מדריכים ותרחישי Katacoda (github.com/iterative/dvc.org/issues/670).
4) אם סעיף ה'הדרכה', עדכון מסמכי DVC 1.0 ותרחישי Katacoda יסתיימו לפני סיום תקופת הכתיבה, שאר העבודה יתבסס על סדר העדיפויות של DVC באותו זמן ועל משימות שונות אחרות.
התחייבות לזמן:
אצטרך להמשיך ללימודים במהלך תקופת הכתיבה. אין לי התחייבויות אחרות חוץ מזו. אוכל להקדיש 30 שעות בשבוע לכל משך הפרויקט.