בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- Apache Cassandra
- כותבים טכניים:
- דבורה
- שם הפרויקט:
- עדכון למסמכי התיעוד של Apache Cassandra 4.0 ופתרון משימות TODO במסמכי התיעוד
- אורך הפרויקט:
- Long running (5 months)
תיאור הפרויקט
הפרויקט מורכב משני פרויקטים משניים:
1. עדכון למסמכי התיעוד של Apache Cassandra 4.0
בודקים ומעדכנים את המסמכים הקיימים של Apache Cassandra כדי לוודא שהם
תואמים לגרסה הבאה של Apache Cassandra 4.0. הגישה שלנו לכך היא לפרסם קריאה ברשימת התפוצה cassandra-dev
כדי לקבל מפתחים של Cassandra שיציינו אזורים במסמך
שצריך לעדכן.
לאחר מכן, נבצע בדיקה
מובנית של המסמכים הקיימים כדי לזהות פערים אפשריים. לדוגמה:
בבדיקה המובנית, הסופר הטכני יכול להשוות בין
המסמכים של קובץ התצורה של Cassandra
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
לבין אפשרויות התצורה שמופיעות בפועל במקור
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java).
2. פתרון משימות TODO במסמכי התיעוד של Apache Cassandra
במסמכי העזרה של Apache Cassandra יש כמה קטעים
שמופיעים עם ההדגשה 'TODO' (או 'משימות שעוד לא הושלמו'). סוגים אלה הם:
- הפעלת Cassandra / גיבויים
- תפעול קסנדרה / טעינה בכמות גדולה
- CQL / הגדרות נתונים (נקודות ביקורת מוגבלות)
- בניית מודלים של נתונים
- Dynamo / Gossip, זיהוי כשלים ו-Token Ring
- ארכיטקטורה/ערבויות
- הפעלת Cassandra/Hints
- ארכיטקטורה/סקירה כללית (מוצע כפרויקט נפרד)
- הפעלת תיקון קריאה ב-Cassandra
- חברים רבים בקהילה יצרו תוכן בנושאים האלה (כולל פוסטים בבלוגים ציבוריים, פוסטים ב-Stack Overflow וכו'). הגישה היעילה ביותר להשלמת החלקים האלה היא לבקש חומרים ומקורות מידע טובים מרשימות התפוצה, ולסכם אותם במסמך תמציתי של קבוצת המסמכים של Apache Cassandra.