ייבוא וייצוא של אתר תיעוד

העבירו את מרכז העזרה הקיים שלכם לאתר תיעוד של Clevera, או הורידו את כל התוכן באתר כקובץ zip. פעולות ייבוא מעבירות דפים, תמונות, מבנה, תרגומים וכתובות ישנות; פעולות ייצוא מספקות לכם את התוכן כקבצי HTML או Markdown. שתי הפעולות הן ללא עלות.

לפני שמתחילים#

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

ייבוא התיעוד שלכם#

1. בחרו את הפלטפורמה שלכם#

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

   

2. התחברות#

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

3. תצוגה מקדימה#

   Clevera מציגה את המקטעים והדפים שמצאה. בטלו את הסימון של דפים שאינכם רוצים. אתר גדול עשוי לקחת דקה: "אנחנו מפרטים כל מקטע ודף."

4. בחרו את האפשרויות#

   בחרו לאן הדפים יועברו ואילו שפות להעביר. ראו אפשרויות ייבוא.

5. אישור והתחלה#

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

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

כשהתהליך מסתיים תקבלו אימייל, "הייבוא שלך מ-platform מוכן", עם צפייה בדוח. לאחר מכן עיינו בדפים ופרסמו את האתר.

פלטפורמות ושיטות#

כל כרטיס פלטפורמה מציג את השיטות הנתמכות: ממשק API, אתר ציבורי ו-מאגר / zip.

השיטות#

אתר ציבורי. הדביקו את כתובת התיעוד הציבורי שלכם (דף הבית או כל דף תיעוד), תחת כתובת אתר. Clevera קוראת את הדפים המפורטים בניווט או במפת האתר, בקצב מתון שמכבד את ה-robots.txt שלכם. רק דפים תחת כתובת זו נקראים. מאמרים פרטיים וטיוטות אינם כלולים.

אסימון או מפתח API. הדביקו אסימון שתיצרו בפלטפורמה האחרת. לכל כרטיס פלטפורמה יש את השלבים וקישור למקום שבו יוצרים אותו. Clevera רק קוראת. אסימונים משמשים בזמן שהייבוא רץ ונמחקים תוך 24 שעות. ניתן לבטל את האסימון בפלטפורמה האחרת ברגע שהייבוא מסתיים.

מאגר Git. הדביקו את כתובת המאגר (GitHub, GitLab או Bitbucket). עבור מאגר GitHub פרטי, הוסיפו אסימון גישה עם גישת קריאה בלבד לתוכן. Clevera מורידה את ענף ברירת המחדל כארכיון ולעולם לא מריצה את הקוד שלו.

העלאת zip. העלו .zip של התיעוד שלכם, עד 200 MB. Clevera קוראת Markdown, MDX, JSON, YAML ותמונות ומתעלמת מכל השאר. עבור כל אתר תיעוד אחר ה-zip יכול להכיל קבצי .md, .mdx או .html, וכל תיקייה ברמה העליונה הופכת למקטע.

הערות פלטפורמה#

• Intercom אינה מאפשרת שיתוף אסימוני גישה עם אפליקציות אחרות, לכן Clevera קוראת את מרכז העזרה הציבורי שלכם.
• גישת API ל-Zendesk דורשת מנהל מערכת בתוכנית Team ומעלה. כל סוכן קורא מאמרים שפורסמו; מנהל Guide מביא גם טיוטות ומאמרים מוגבלים.
• Help Scout מאפשרת לכם לבחור מאמרים שפורסמו בלבד או מאמרים שפורסמו וטיוטות. מפתחות ה-API שלה לא יכולים להיות לקריאה בלבד, לכן מחקו את המפתח לאחר מכן.
• דפי הפניה ל-API, מתכונים ודפים מותאמים אישית של ReadMe נשארים ב-ReadMe.
• גישת API ל-Document360 קיימת בתוכניות Business ו-Enterprise ודורשת מפתח API חדש יותר.
• Notion דורשת מבעל סביבת העבודה ליצור את החיבור, עם "קריאת תוכן בלבד".
• Confluence עובדת עם אתרי Confluence Cloud.
• תיעוד עם מספר גרסאות: רק הגרסה החדשה ביותר מיובאת.

אפשרויות ייבוא#

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

איך המבנה עובר#

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

מגבלות#

הכרטיס מציג כמה ייבואים נותרו להיום ואת מגבלת הדפים.

דוח הייבוא#

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

דוגמאות לאזהרות:

• "דף זה היה מקונן עמוק יותר ממה שאתרי תיעוד מאפשרים, לכן הוא הועלה רמה אחת למעלה."
• "לא ניתן היה להעתיק תמונה, לכן היא נשארה בחוץ"
• "דף עם כתובת זו כבר קיים כאן, לכן הוא נדלג."
• "נדלג: robots.txt או כללי הכתובת של האתר מונעים מאיתנו לקרוא דף זה."

ביטול או עצירת ייבוא#

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

ייצוא אתר#

1. בחרו פורמט#

   תחת ייצוא הנתונים שלך, בחרו את פורמט ייצוא: HTML (דפים שפותחים בדפדפן, תמונות בתיקייה משלהן) או פורמט Markdown (קבצי .md פשוטים, תמונות בתיקייה משלהן).

   

2. בקשו זאת#

   לחץ על בקש ייצוא. תראה את ההודעה "Export requested. We'll email a download link to" הכתובת שלך, "usually within 10 minutes".

3. הורד אותו#

   פתח את האימייל "Your export of site is ready" ולחץ על הורד ייצוא. עליך להיות מחובר ל-Clevera. הקישור פעיל למשך 7 ימים; הייצוא מופיע גם תחת הכרטיס עם הורדה עד לפקיעת תוקפו.

קובץ ה-zip מכיל:

• כל עמוד באתר, כולל טיוטות המסומנות כ-"Draft", בכל שפה, וגם עמודי האתר.
• יומן השינויים (changelog), כולל טיוטות.
• תמונות, כאשר כל אחת נשמרת פעם אחת.
• הניווט, הגדרות האתר, הפניות (redirects) (redirects.csv) ורשימת סרטונים (videos.csv), עם README.txt שמסביר על הקבצים.

ניתן לבקש 3 ייצואים לכל אתר ביום (בחלון זמן מתגלגל של 24 שעות). ייצוא שנכשל אינו נספר. רק האדם שביקש את הייצוא יכול להוריד אותו. כאשר הבעלים מבצע ייצוא, מנהלי המערכת מקבלים התראה שבוצע ייצוא.

סרטונים#

סרטונים אינם כלולים בקובץ ה-zip. בקבצים, כל סרטון הוא קישור: "Watch / export this video". כרטיס ה-סרטונים מציג את כל סרטוני Clevera בעמודי האתר עם ייצוא סרטון, שפותח את הסרטון כדי שתוכל לייצא אותו באיכות הרצויה לך.

פתרון בעיות#

קשור#