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