פרויקט PostgreSQL

דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google Docs.

סיכום הפרויקט

ארגון הקוד הפתוח:

PostgreSQL

כתב טכני:

ל'

שם הפרויקט:

מדריך היכרות

אורך הפרויקט:

אורך רגיל (3 חודשים)

תיאור הפרויקט

עדכון של מדריך המבוא לשיפור חוויית ההתקנה וההגדרה של PostgreSQL למתחילים. (https://www.postgresql.org/docs/current/tutorial-start.html)

1. ממירים את הפרק Architectural Fundamentals למבוא מקיף למדריכי PostgreSQL (https://www.postgresql.org/docs/current/tutorial-arch.html). ניתן להרחיב את הדברים הבאים: ארכיטקטורת שרת לקוח, psql כדוגמה ללקוח לשימוש במדריך זה, טרמינולוגיה של "cluster" בהקשר של PostgreSQL, משתמשי DB לעומת מערכות הפעלה ובעלות.

2. עדכון מדריך ההתקנה (https://www.postgresql.org/docs/current/tutorial-install.html).

   • פרסום גם אפשרות התקנה מקורית וגם אפשרות התקנה בינארית. אפשר להוסיף הפניה אל https://www.postgresql.org/download/, שמציעות מעט מאוד הוראות להתקנה של קובץ בינארי.
   • זהה פערים בהוראות התקנה בינאריות, אם יש, ומרחיבים את האתר או מטפלים בהן בתיעוד.
   • אל תסתמך על המשתמשים שיקראו את פרק התקנת המקור המלא ויגלו אותו: יש לתאר את השלבים העיקריים הנדרשים לאחר ההתקנה, כמו אתחול האשכול והפעלה (אוטומטית) של השרת. לספק קישורים לפרקי עזרה ספציפיים כדי לקבל פרטים נוספים, במקרים הרלוונטיים.
   • אפשר להוסיף קישורים מסוג 'גלוי גם' למשאבים רלוונטיים, שכוללים הרחבה על ברירות המחדל ושיטות מומלצות עבור מערכת הפעלה מסוימת, אם יש כאלה שהקהילה מכירה.

3. לשיפור https://www.postgresql.org/docs/current/tutorial-createdb.html

   • הימנעו ככל האפשר מהוראות "התייעץ במנהל המערכת". ספקו פתרונות פרקטיים על סמך ההנחה שהמשתמש פעל בהתאם למדריך המפורט.

4. לשיפור https://www.postgresql.org/docs/current/tutorial-accessdb.html

   • הסבר על בעיות בסיסיות שקשורות לאימות ודוגמאות טריוויאליות ל-pg_hba.conf

כדי לספק תיקון התיעוד הזה, אני מתכוון לנסות את המדריך הנוכחי ב-Windows וב-Ubuntu, לעיין בפורומים לפתרון בעיות התקנה נפוצות ולהתייעץ עם מנטורים כדי לוודא שאקבל את שיטות העבודה המומלצות ושהמושגים החשובים ביותר מוסברים בלי לפשט את העניינים.