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