בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון בקוד פתוח:
- ג'נקינס X
- כותבים טכניים:
- Nitin
- שם הפרויקט:
- ארגון מחדש של אתר מסמכי Jenkins X ומטריצת היכולות של Jenkins X
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
המטרה העיקרית של הפרויקט היא לבצע רפרסטורציה של המסמכים הקיימים של Jenkins X, תוך תיקון הבעיות שקשורות למסמכים, וכן להכין את מטריצת היכולות המעודכנת של Jenkins X יחד עם מסמכי התיעוד של המשתמשים לגבי השימוש ב-Jenkins X אצל ספקי הענן הארגוניים. בנוסף, הפרויקט הזה כולל גם פיתוח של תשתית לסביבת תצוגה מקדימה של Jenkins X שמבוססת על OpenShift, בשיתוף עם דניאל.
כחלק מהארגון מחדש של המסמכים הקיימים של Jenkins X, חלק מהבעיות שאעבוד עליהן כוללות:
- Boot in EKS Resources: Issue
- Vault נכשל ב-EKS עם Boot: בעיה
- Document envars for jx boot: Issue
- המסמכים הדרושים להגדרת Vault: בעיה
- שדרוג האתחול מהאחסון המקומי לאחסון מאובטח נכשל: בעיה
- משוב לגבי מסמכי התיעוד: הקשר בין 'create' לבין 'install jx' לבין 'boot' לבין 'import': בעיה
- מסמכי התיעוד של helm
- שיפור המסמכים בנושא הסיבה לכך ש-ChartMuseum, Monocular ו-Docker Registry לא מוחלפים ב-Nexus
- לא ניתן לשנות את Docker Registry במהלך השימוש באתחול + GKE: בעיה
- שינוי הדומיין מ-nip.io לדומיין מותאם אישית נכשל: Issue
במטריצה של יכולות Jenkins X, העבודה כוללת (כפי שמוזכר בהמשך) שירותי Kubernetes ארגוניים שמוצעים על ידי כל אחד מספקי הענן, כלומר: Google Cloud (GKE), Amazon Web Services (AWS EKS) ו-Azure Cloud (AKS).
- התקנת Jenkins X בענן באמצעות סקריפטים מסוג terraform ו-
jx boot - בדיקת התאימות של גרסאות Kubernetes עם Jenkins X בשירותי kubernetes של ספקי שירותי הענן.
- כל יכולת אחרת (אחסון Vault לסודות, גרסאות של בקרת מקורות או אחרים) שצריך לדון בה עם Deane וחברי הקהילה של Jenkins X.
בנוגע לעבודה על הגדרת התשתית של סביבת התצוגה המקדימה של Jenkins X שמבוססת על OpenShift, העבודה כוללת:
- עיצוב מסמך בתשתית של סביבת התצוגה המקדימה של Jenkins X בפלטפורמת OpenShift
- יצירה אוטומטית של סביבות תצוגה מקדימה של Jenkins X ב-OpenShift
- עדכון התיעוד של Jenkins X בסביבות תצוגה מקדימה
פריטים נדרשים בפרויקט:
- תיקונים באמצעות יחסי הציבור לבעיות במסמכים שצוינו למעלה, תוך התחשבות בסידור מחדש של מסמכי Jenkins X הקיימים.
- מטריצה מעודכנת של היכולות של Jenkins X, יחד עם מסמכי התיעוד למשתמש בנושא שימוש ב-Jenkins X עם ספקי ענן שונים (שירותי Kubernetes, בעיקר AKS, EKS ו-GKE).
- הגדרה אוטומטית של סביבת התצוגה המקדימה של Jenkins X תשתית המבוססת על OpenShift, בשיתוף עם דניאל.
הצעה לציר זמן לא סופי (יחד עם משימות):
יצירת קשרים בקהילה (17 באוגוסט עד 13 בספטמבר)
- הגדרת סביבת פיתוח למסמכי תיעוד טכניים, וקבלת גישה לתשתיות ענן לעבודה על משימות הפרויקט.
- שיחה עם מנחי הפרויקט לגבי ציר הזמן המשוער שהצעתם, המוצרים שייוצרו במסגרת הפרויקט והמשימות (יחד עם רמת העדיפות שלהן).
- להבין את תהליך העבודה של הארגון ואת תהליך הבדיקה של יחסי הציבור, ולהשתתף בקהילה.
- בודקים את מצב התיעוד הנוכחי של Jenkins X.
שבוע 1 (14 עד 20 בספטמבר)
- הסבר על ההוראות להגדרת Jenkins X בענן, המצב הנוכחי והמסמכים.
- שיחה עם Deane על היכולות הנוכחיות של Jenkins X (לבדיקה אצל ספקי ענן שונים).
- שיחה עם דניאל על המצב הנוכחי של התשתית של סביבת התצוגה המקדימה של Jenkins X שמבוססת על OpenShift.
- עבדו (בשיתוף עם דניאל) על תכנון ארכיטקטורה עבור תשתית סביבת התצוגה המקדימה של Jenkins X ב-OpenShift.
שבוע 2 (21 בספטמבר עד 27 בספטמבר)
- עבודה על מטריצת היכולות של Jenkins X בענן GKE: התקנה של Jenkins X והכנת טיוטות של הערות משתמשים.
- לעבוד על אחת מהמסמכים הקשורים לשיפור המסמכים הקיימים של Jenkins X.
שבוע 3 (28 בספטמבר עד 4 באוקטובר)
- עבודה על מטריצת היכולות של Jenkins X בענן GKE: התקנה של Jenkins X והכנת טיוטות של הערות משתמשים.
- עבודה על אחת מהבעיות בנושא מסמכים כדי לשפר את המסמכים הקיימים של Jenkins X.
- עבודה על מסמך התכנון של התשתית של סביבת התצוגה המקדימה של Jenkins X שמבוססת על OpenShift.
שבוע 4 (5 באוקטובר עד 11 באוקטובר)
- סיום הכנת מסמכי התיעוד למשתמשים של Jenkins X ב-GKE.
- עבודה על אחת מהבעיות בנושא מסמכים כדי לשפר את המסמכים הקיימים של Jenkins X.
שבוע 5 (12 באוקטובר עד 18 באוקטובר)
- עבודה על מטריצת היכולות של Jenkins X בענן Azure (AKS): התקנה של Jenkins X והכנת טיוטות של הערות משתמשים.
- עבודה על אחת מהבעיות בנושא מסמכים כדי לשפר את המסמכים הקיימים של Jenkins X.
- לאחר קבלת משוב מחברי הקהילה, נסיים לכתוב את מסמך העיצוב של התשתית של סביבת התצוגה המקדימה של Jenkins X שמבוססת על OpenShift.
שבוע 6 (19 באוקטובר עד 25 באוקטובר)
- עבודה על מטריצת היכולות של Jenkins X בענן Azure (AKS): התקנה של Jenkins X והכנת טיוטות של הערות משתמשים.
- עבודה על אחת מהבעיות בנושא מסמכים כדי לשפר את המסמכים הקיימים של Jenkins X.
שבוע 7 (26 באוקטובר עד 1 בנובמבר)
- עבודה על מטריצת היכולות של Jenkins X לענן Azure (AKS): התקנת Jenkins X והכנת טיוטות של הערות משתמש.
- עבודה על אחת מהבעיות בנושא מסמכים כדי לשפר את המסמכים הקיימים של Jenkins X.
- עבודה על הגדרת התשתית של סביבת התצוגה המקדימה של Jenkins X שמבוססת על OpenShift.
שבוע 8 (2 בנובמבר עד 8 בנובמבר)
- השלמת מסמכי המשתמש של Jenkins X ב-AKS.
- עובדים על אחת מהמסמכים הקשורים לשיפור המסמכים הקיימים של Jenkins X.
שבוע 9 (9 בנובמבר עד 15 בנובמבר)
- עבודה על מטריצת היכולות של Jenkins X ל-AWS (EKS): התקנת Jenkins X והכנת טיוטות של הערות משתמש.
- עבודה על אחת מהבעיות בנושא מסמכים כדי לשפר את המסמכים הקיימים של Jenkins X.
- עבודה על הגדרת התשתית של סביבת התצוגה המקדימה של Jenkins X שמבוססת על OpenShift.
שבוע 10 (16 עד 22 בנובמבר)
- עבודה על מטריצת היכולות של Jenkins X ל-AWS (EKS): התקנה של Jenkins X והכנת טיוטות של הערות משתמשים.
- עבודה על אחת מהבעיות בנושא מסמכים כדי לשפר את המסמכים הקיימים של Jenkins X.
שבוע 11 (23 בנובמבר עד 29 בנובמבר)
- סיום הכנת מסמכי התיעוד למשתמש של Jenkins X ב-EKS.
- עבודה על אחת מהבעיות בנושא מסמכים כדי לשפר את המסמכים הקיימים של Jenkins X.
- לסיים את התיעוד של התשתית של סביבת התצוגה המקדימה של Jenkins X באתר המסמכים של Jenkins X.
שבוע 12 (30 בנובמבר עד 5 בדצמבר)
- מסיימים את יצירת המוצרים של הפרויקט ומבצעים רפאקציה של הקוד, אם יש כזה, על סמך המשוב.
- בדיקה של אתר המסמכים של Jenkins X, כולל קישורים, תמונות, היפר-קישורים ועוד.
- בודקים את אמצעי הבקרה והניווט המוגדרים על ידי המשתמש באתר המסמכים של Jenkins X.
- כאן אפשר למצוא את המטריצה הסופית של יכולות Jenkins X.
לפני 10 בדצמבר 2020 גם הכותבים הטכניים וגם המנטורים שולחים הערכה של הפרויקט.
מהם היתרונות של הפרויקט המוצע ל-Jenkins X ולקהילתו? הפרויקט הזה יעזור לקהילת Jenkins X לשפר את המסמכים למשתמשים הקצה ולמפתחים, כדי לספק להם מידע על הארכיטקטורה הטכנית, התאימות, השימוש והשילוב של Jenkins X. לאחר השלמת הפרויקט המוצע, היה קיים תיעוד מלא, מוגדר היטב ומאומת מבחינה טכנית של Jenkins X יחד עם מטריצת היכולות של Jenkins X, בנוגע לתאימות שלה לספקי ענן שונים.
על אילו הטבות אתם מתכננים לעבוד עם Jenkins X? אחרי שהעונה של תוכנית Docs 2020 ב-Google תסתיים, אני אהיה פעיל/ת בקהילה לטווח הארוך בפרויקט Jenkins X. תמיד אהיה שם כדי לעזור לאחרים (מתחילים) ולעודד אותם להצטרף לקהילה של Jenkins X. תמיד אשמח לעבוד על רעיונות אחרים לפרויקטים של Jenkins X.
אלה כמה מהסיבות לכך שאני מתאים ביותר לעבוד על הפרויקט הזה:
- אני מאוד שיטתי ומאורגן. אני מצפה מאוד לעדכן את מנחי הפרויקט ואת קהילת הארגון לגבי ההתקדמות של הפרויקט באמצעות פוסטים בבלוג פעם בשבוע, פגישות שבועיות מתוזמנות של SIG-docs ואימיילים באופן קבוע.
- יבקשו הדרכה ותשובות מהמנחים ומחברי הקהילה לעיתים קרובות, כדי להתקדם במשימות ולוודא שכולם מעודכנים (כולל ציון של אתגרים או נקודות חסימה שנתקלו בהן).
- ביצוע השמירה של כל קוד המקור שנכתב באופן קבוע, כדי שהקוד ייבדק על ידי המנטור, התורמים ותיעוד העבודה שבוצעה לצורך התייחסות של חברי הקהילה.
- יש לי את כל הכישורים הטכניים הנדרשים כדי לעבוד על רעיון הפרויקט הזה, ודנתי בתוכנית הפרויקט עם המנטורים דין, קרה ודניאל. יש לי הבנה מעמיקה של הצעת הפרויקט והתוצרים שלו.
- יש לי ניסיון בעבודה עם המיומנויות הטכניות (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo ועוד) שנדרשות כדי לספק מסמכים מלאים ולפתור את רוב הבעיות שקשורות למסמכים. יש לי גישה חיובית ויכולת להשלים את העבודה בפרויקט בזמן, עם מעט פיקוח.