בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון בקוד פתוח:
- פרויקט FreeBSD
- כותבים טכניים:
- Larry
- שם הפרויקט:
- עדכונים למדריכים של FreeBSD
- אורך הפרויקט:
- Long running (5 months)
תיאור הפרויקט
הפרויקט הזה של GSoD2020 יכלול שני פרקים בספרי FreeBSD:
- בדיקה: פרק חדש במדריך למפתחים של FreeBSD
- LDAP: כתבה מעודכנת ששולבה בפרק במדריך FreeBSD
בדיקה: פרק חדש במדריך למפתחים של FreeBSD:
הערה: הפרויקט הזה הוא בעיקר מחקרי בהתחלה. הדרישות עשויות להשתנות במהלך שלב הכתיבה.
משימות ההכנה כוללות: * בדיקת המסמכים וההערות העדכניים לגבי מסגרות בדיקה, שיטות וכו' למפתחים ב-FreeBSD וב-BSD אחרים. * מסמכי תיעוד והערות עדכניים או ישנים יותר של FreeBSD. לדוגמה: * TestSuite: https://wiki.freebsd.org/TestSuite * דף "TestingFreeBSD" הישן: https://wiki.freebsd.org/TestingFreeBSD * תיעוד עדכני והערות מפרויקטים קשורים. לדוגמה: * http://wiki.netbsd.org/tutorials/atf/ * תיעוד ראשי של הכלים הרלוונטיים. לדוגמה: * Kyua Testing framework: https://github.com/jmmv/kyua/ * Automatic Testing Framework (ATF): https://github.com/jmmv/atf/ * התקנה והגדרה של ה-frameworks הרלוונטיות כדי להכיר טוב יותר את המסגרות הרלוונטיות. * שימוש במסגרות הבדיקה כדי להריץ את הבדיקות הנוכחיות. * כתיבת מספר קטן של בדיקות חדשות. * (חשוב מאוד) ייעוץ עם הקוראים (מפתחי תוכנה ובודקים) לגבי מה שהם רוצים לראות בפרק.
אנחנו עדיין צריכים לקבוע את האופן המדויק שבו המסמכים יתארגנו. עם זאת, אחרי קריאת הפרק, הקורא אמור להיות מסוגל לבצע לפחות את הפעולות הבאות:
- התקנה והגדרה של מסגרות הבדיקה לצורך בדיקת FreeBSD.
- כותבים בדיקה למסגרת הבדיקה.
- הרצת בדיקה במסגרת הבדיקה.
נתמקד בנושאים הבאים, במידת האפשר: * אוטומציה מקסימלית כדי לצמצם את העבודה בהגדרת תשתית הבדיקה, בכתיבת בדיקות ובהרצת בדיקות. * הוספת מקרי בדיקה בכל פעם שמתקנים באג חדש. * בדיקות רגרסיה אוטומטיות מקיפות. * (אם רלוונטי) דוגמאות לתרחישי בדיקה סטנדרטיים, כמו בדיקת יחידה, בדיקה פונקציונלית, בדיקת עומס וכו'.
כשהדבר אפשרי, המטרה היא לא רק להסביר למפתחים את מסגרת הבדיקות ולהדריך אותם בה, אלא גם לשמור על התהליך פשוט ככל האפשר כדי לעודד מפתחים לשלב יותר בדיקות, וכדי שמפתחים חדשים לא ירתעו מלתרום.
LDAP: כתבה מעודכנת ששולבה בפרק במדריך FreeBSD:
בניגוד לפרק בנושא בדיקה, היקף העדכון של כתבה או פרק בנושא LDAP ברור.
גם הפרק הנוכחי במדריך FreeBSD וגם המאמר הנוכחי מכילים הרבה מידע שימושי. עם זאת, צריך לעדכן אותן. התחלנו לעבוד על גרסה חדשה של המאמר, שמיועדת להפוך לפרק החדש, אבל היא עדיין לא הושלמה.
המשימות כוללות: * הגהה של הפרק הנוכחי במדריך ושל המאמר הנוכחי. * כהכנה ל-GSoD2020, בוצע מעבר ראשוני. * בדיקה של כל קטע במדריך כדי לוודא מה עובד ומה צריך לשנות. * כהכנה ל-GSoD2020, תצורת השרת נבדקה וזוהו שיפורים. * נותרו קטעים אחרים. * כתיבת תוכן חדש ותיקון של תוכן קיים. * התוכן המעודכן התחיל להופיע בקטע של השרת. צריך להשלים אותו. * נותרו קטעים אחרים. * בדיקת כל התוכן במערכות FreeBSD נקיות אחרי השלמת טיוטה סופית. * המשימה הזו חיונית כי היא מזהה את הפערים.
המאמר או הפרק הסופי במדריך צפויים לכלול את הקטעים הבאים:
(1) מבוא ל-LDAP (2) הגדרת שרת: (א) הסבר מפורט על הגדרת שרת OpenLDAP בסיסית אך פונקציונלית ב-FreeBSD. (ב) דוגמה מלאה להגדרה בסיסית אך פונקציונלית של שרת OpenLDAP, למשל התוצאה של (2א), ב-FreeBSD.
"בסיסי אך פונקציונלי" כולל תצורה של השרת עם סיסמאות מגובבות, חיבורים מאובטחים דרך הרשת ונתוני משתמש מדומים אך מייצגים לדוגמה.
(אופציונלי – ההחלטה תתקבל במהלך GSoD2020) תצורת השרת עשויה לכלול גם כיסוי מקביל של 389 Directory Server ב-FreeBSD. הייתה תמיכת FreeBSD ניסיונית ב-Directory Server 389, אבל יש לאשר את הסטטוס הנוכחי שלו.
(3) הגדרת לקוח: (א) הדרכה מפורטת והסברים על הגדרת לקוח תקינה ב-FreeBSD, שיכולה להתחבר לחיבור השרת לדוגמה שסופק ב-(2). (ב) דוגמה מלאה לתצורה של לקוח פונקציונלית, למשל התוצאה של (3a), ב-FreeBSD.
הקטע 'הגדרת לקוח' יכלול קטעים משניים בנושאים הבאים: * מודול אימות מחובר (PAM), למשל pam_ldap, pam_mkhomedir, nss-pam-ldapd * מתג שירות שמות (NSS), למשל nss_ldap, nss-pam-ldapd * (אופציונלי – ההחלטה תתקבל במהלך GSoD2020) SSSD – צריך לאשר את הסטטוס של SSSD בסביבת הייצור ב-FreeBSD. * (אופציונלי – ההחלטה תתקבל במהלך GSoD2020) FreeIPA – צריך לבדוק את השימוש ב-FreeIPA ואת הפונקציונליות שלו ב-FreeBSD. FreeIPA מכסה יותר מ-LDAP, לכן צריך להעריך את היקף ההגדרה של FreeIPA לפני ההכללה בפרק הזה במדריך.
(4) שיקולי אבטחה * הגרסה הנוכחית של המאמר כוללת קטע בנושא שיקולי אבטחה. יכול להיות שחלק מהתוכן הזה יועבר לקטע הרלוונטי. עם זאת, עדיין צריך לכלול קטע ייעודי בנושא שיקולים בנושא אבטחה.
(5) פתרון בעיות * אסטרטגיות לפתרון בעיות בהגדרת LDAP.
(6) נספח OpenSSL
בעזרת הפרק או המאמר המעודכנים בספר, הקורא יכול להשתמש בשתי מערכות נקיות של FreeBSD, להגדיר שרת LDAP ולקוח LDAP ולאמת את הלקוח מול השרת.
לאחר קריאת הפרק / המאמר המעודכן במדריך, על הקורא לקבל את היסודות הדרושים לקבלת מסמכים מיוחדים או מקיפים נוספים, כמו תיעוד של OpenLDAP, LDAP RFC, וליצור או לשפר את תצורת FreeBSD כדי לעמוד בדרישות.