מידע כללי
הוויקיפדיה הציבורית שלנו פתוחה לכולם ומטרתה היא לאסוף ולתעד במקום אחד את כל המידע הקשור בפרויקטים, במערכות, ובקהילה שלנו, לשימוש חופשי ונוח.
בוויקיפדיה שלנו תוכלו למצוא מידע חשוב ושימושי על תפקוד השרתים, המדיניות שלנו, מידע מעמיק על הפרויקטים והמערכות השונות, ועוד מגוון רחב של תכנים שיכולים להועיל לכם.
על מנת לתעד את כל המידע החשוב הזה, אנו ז קוקים לשיתוף הפעולה שלכם. לכן, החלטנו להפוך את כל התכנים לזמינים לציבור ולאפשר לכל אחד לתרום לוויקי שלנו.
הוויקיפדיה שלנו היא פרויקט בקוד פתוח, מה שמזמין אתכם לקחת חלק פעיל ולתרום לפיתוחה ולשדרוגה בהתאם לצרכים המשתנים של הקהילה.
איך הוויקיפדיה שלנו עובדת?
אנחנו משתמשים בכלי קוד פתוח וחינמי בשם Docusaurus, שמאפשר לנו ליצור וויקי פשוטה, קלה לשימוש ומהירה להקמה. הפלטפורמה הזו עוזרת לנו לארגן את כל המידע של הקהילה והפרויקטים שלנו במקום אחד בצורה ברורה וידידותית.
מה זה Docusaurus?
Docusaurus הוא כלי מבית Facebook המיועד לבניית אתרים סטטיים, תוכנן במיוחד עבור תיעוד פרויקטים ובלוגים. הכלי מאפשר לכתוב תוכן פשוט באמצעות Markdown ולשלב אותו עם HTML, CSS, ו-JavaScript במידת הצורך. היתרון המרכזי של Docusaurus הוא השילוב בין קלות שימוש ותמיכה בפונקציות מתקדמות, מה שהופך אותו למתא ים גם לפרויקטים קטנים וגם לפרויקטים מורכבים בקוד פתוח. Docusaurus הוא פתרון מצוין עבור מפתחים, צוותים טכניים, וכל מי שזקוק לאתר תיעוד מודרני ויעיל.
מבנה הפרויקט
הנה פירוט המבנה של הפרויקט שלנו ב-Docusaurus:
- /docs – ספריית התיעוד הראשית, שם נשמרים כל הקבצים בפורמט Markdown.
- /src – קבצים מותאמים אישית כמו רכיבי React וסגנונות CSS.
- /static – קבצים סטטיים כמו תמונות, סרטונים, ותכנים אחרים שלא משתנים.
המבנה המותאם שלנו
בתוך ספריית /docs
תוכלו למצוא מבנה ייחודי שמארגן את התוכן שלנו לפי נושאים וקטגוריות:
- /docs/community – כל התוכן הקשור לקהילה ולשרת הדיסקורד שלנו. כאן תוכלו לערוך ולהוסיף מידע שקשור לפעילות הקהילתית.
- /docs/servers/fivem – מידע וכלים הקשורים לשרתי ה-FiveM שלנו. המדריכים והעדכונים החשובים בנושא זה נשמרים כאן.
- /docs/lab – ה-"מעבדה" שלנו, שהוא בית הפיתוח של הקהילה, עם תיעוד לכלי פיתוח, פרויקטים ייחודיים ועוד.
- /docs/legal – תיעוד מדיניות החברה והקהילה, כולל חוקים, תנאים, והסכמים שונים.
- /docs/tutorials – כל המדריכים וההדרכות שלנו, שמיועדים לעזור לכם להשתמש בכלים ולנהל את הפרויקטים בצורה הטובה ביותר.
איך מוסיפים תוכן
לפני שנתחיל להוסיף תוכן חשוב להכין כמה דברים
-
Fork the repo חייב ליצור העתק של המאגר כדי להוסיף תוכן חדש https://github.com/tgilabs/public-docs/fork
-
הורידו את המאגר למחשב שלכם
git clone https:://github.com/your-username/public-docs
- תפתחו את הקובץ שאתם רוצים לערוך עם כלי עריכה כמו VSCode
cd public-docs
code .
התחילו לערוך קבצים ולהוסיף תוכן חדש בהתאם למה שאתרם רוצים