דלג לתוכן הראשי

הוספת תוכן

לפני שנתחיל להוסיף תוכן חדש לוויקי שלנו, חשוב להכין כמה דברים מראש:

שלב 1: Fork למאגר (Repository)​

כדי להוסיף תוכן חדש, עליכם ליצור העתק של המאגר הראשי כך שתוכלו לבצע שינויים מבלי להשפיע על המאגר הראשי. היכנסו למאגר הבא ולחצו על כפתור ה-Fork כדי ליצור עותק למאגר בחשבון GitHub שלכם:

יצירת Fork

שלב 2: הורדת המאגר למחשב המקומי​

כדי לערוך את הקבצים במחשב המקומי שלכם, עליכם לשכפל (clone) את המאגר שהעתקתם למחשב שלכם.

הריצו את הפקודה הבאה:

git clone https://github.com/your-username/public-docs

הפקודה תוריד את המאגר לספרייה בשם public-docs במחשב שלכם.

שלב 3: עריכת הקבצים​

לאחר שהורדתם את המאגר למחשב, גשו לספרייה הזו:

cd public-docs

פתחו את הספרייה בעורך טקסט כמו VSCode באמצעות הפקודה:

code .

כעת, תוכלו להתחיל לערוך קבצים ולהוסיף תוכן חדש לפי הצורך.

שלב 4: התקנת NPM ו-Yarn (באופן מפורט)​

לפני שתוכלו להפעיל את הפרויקט המקומי שלכם ולבצע שינויים, עליכם לוודא שהתקנתם את הכלים הבסיסיים הנדרשים: NPM ו-Yarn.

מה זה NPM?​

NPM (Node Package Manager) הוא מנהל חבילות עבור Node.js, והוא מגיע יחד עם ההתקנה של Node.js. NPM מאפשר לכם לנהל ולהתקין חבילות (ספריות וקבצי קוד) שפרויקטים שלכם משתמשים בהם. Docusaurus משתמש בחבילות שונות לניהול התיעוד, ולכן יש צורך ב-NPM כדי לנהל את התלויות הללו.

מה זה Yarn?​

Yarn הוא כלי מתקדם לניהול חבילות, שמבוסס על NPM אבל מציע ביצועים משופרים ועבודה מקבילה טובה יותר. Docusaurus ממליץ להשתמש ב-Yarn לניהול הפרויקט, שכן הוא מאפשר ניהול תלויות בצורה מהירה ויעילה יותר.

איך מתקינים את NPM?​

  1. התקנת Node.js: NPM מגיע מובנה עם Node.js, ולכן הדבר הראשון שצריך לעשות הוא לוודא ש-Node.js מותקן במערכת שלכם. כדי להתקין את Node.js (כולל NPM), גשו לאתר הרשמי של Node.js: https://nodejs.org

  2. הורידו והתקינו את גרסת ה-LTS המומלצת (Long Term Support). בסיום ההתקנה, NPM יותקן אוטומטית יחד עם Node.js.

  3. בדיקת ההתקנה: לאחר ההתקנה, פתחו את הטרמינל (Terminal) ובדקו האם Node.js ו-NPM הותקנו בהצלחה על ידי הפקודות הבאות:

    node -v
    npm -v

    פקודות אלו יציגו את גרסאות Node.js ו-NPM המותקנות, ואם הן מציגות גרסאות, הכל מוכן.

איך מתקינים את Yarn?​

כעת, לאחר ש-NPM מותקן, נתקין את Yarn.

  1. התקנת Yarn באמצעות NPM: הריצו את הפקודה הבאה בטרמינל כדי להתקין את Yarn בצורה גלובלית (כך שתוכלו להשתמש בו בכל פרויקט):

    npm install --global yarn

    הפקודה הזו תתקין את Yarn באופן גלובלי על המערכת שלכם.

  2. בדיקת ההתקנה של Yarn: לאחר התקנת Yarn, תוכלו לבדוק אם ההתקנה הצליחה על ידי הפקודה הבאה:

    yarn -v

    הפקודה תציג את גרסת Yarn המותקנת. אם מופיעה גרסה, ההתקנה הושלמה בהצלחה.

מה עושים במקרה של בעיות?​

אם אתם נתקלים בבעיות בהתקנת Node.js, NPM או Yarn, אפשר לנסות את הצעדים הבאים:

  1. התקנה מחדש: נסו להסיר את ההתקנה של Node.js ולהתקין שוב מהאתר הרשמי.

  2. עדכון NPM: ייתכן שגרסת NPM במערכת שלכם ישנה. עדכנו אותה עם הפקודה הבאה:

    npm install -g npm

  3. התקנה ידנית של Yarn: במידה ו-NPM לא הצליח להתקין את Yarn, תוכלו להשתמש במדריך ההתקנה הרשמי של Yarn, המציע התקנות עבור מערכות הפעלה שונות: https://classic.yarnpkg.com/en/docs/install

שלב 6: הפעלת שרת פיתוח מקומי​

לאחר ההתקנה, ניתן להפעיל שרת פיתוח מקומי כדי לבדוק את השינויים שלכם לפני שאתם מעלים אותם למאגר. שרת הפיתוח יעדכן אוטומטית את האתר כאשר תבצעו שינויים בקבצים.

yarn start

שרת הפיתוח יפתח את האתר שלכם באופן מקומי על כתובת localhost:3000, ותוכלו לראות את השינויים שביצעתם בזמן אמת.

שלב 7: הוספת תוכן לפי קטגוריות​

המבנה שלנו מאפשר ארגון התוכן לפי קטגוריות, כך שתוכלו להוסיף תוכן רלוונטי בכל אחת מהן:

  • /docs/community – כל התוכן שקשור לפעילות הקהילתית ושרת הדיסקורד שלנו.
    • עריכה: הוסיפו מדריכים ותיעוד של פעילות הקהילה.
  • /docs/servers/fivem – מדריכים ועדכונים לשרתי ה-FiveM שלנו.
    • עריכה: הוסיפו מידע, מדריכים וטיפים לניהול ושימוש בשרתי ה-FiveM.
  • /docs/lab – כל התיעוד לכלי פיתוח ופרויקטים במעבדת טגי.
    • עריכה: הוסיפו תיעוד של פרויקטים קהילתיים ופיתוחים ייחודיים.
  • /docs/legal – תיעוד כל המדיניות, התנאים וההסכמים הקשורים לחברה והקהילה.
    • עריכה: עדכנו חוקים, תנאי שימוש, ומדיניות פרטיות.
  • /docs/tutorials – מדריכים והדרכות למשתמשים.
    • עריכה: הוסיפו מדריכים בנושאים שונים לעזרה למשתמשים.

שלב 8: הגשת השינויים למאגר הראשי בעזרת Pull Request (PR)​

לאחר שסיימתם להוסיף את התוכן ולבדוק אותו בשרת הפיתוח המקומי, הגיע הזמן להעלות את השינויים למאגר GitHub שלכם ולהגיש Pull Request למאגר הראשי.

  1. ראשית, יש להוסיף את השינויים שביצעתם:
git add .
  1. כעת, יש לשמור את השינויים עם הודעה המתארת את מה שעשיתם:
git commit -m "הוספת תוכן חדש לקטגוריה [category_name]"
  1. דחפו (Push) את השינויים למאגר GitHub שלכם:
git push origin main
  1. היכנסו למאגר שלכם ב-GitHub ופתחו Pull Request (בקשת משיכה) כדי להגיש את השינויים למאגר הראשי.
  • וודאו שה-PR שלכם מתאר בצורה ברורה את השינויים שביצעתם ומסביר למה השינויים חשובים או מה הם כוללים.

לאחר שהשינויים שלכם ייבדקו ויאושרו, הם יתווספו למאגר הראשי.