יצירת מדריכים פרטיים ב-Cloud Shell

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

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

אתם יכולים להשתמש בכל שירות אירוח מאגרי Git שתרצו. במדריך הזה נעשה שימוש ב-Secure Source Manager, מאגר המקורות של הקוד מנוהל עם דייר יחיד שמתארח ב- Google Cloudומופעל באופן אזורי, כדי להדגים את השלבים.

יצירת מאגר Git פרטי

מופעים של Secure Source Manager נפרסים באזור זמין Google Cloud ואפשר לגשת אליהם דרך כתובות ה-URI של המופעים. מאגרי מידע נוצרים במופע של Secure Source Manager באמצעות ממשק אינטרנט או Secure Source Manager API.

כדי ליצור מאגר Secure Source Manager לאירוח של מדריך פרטי, מבצעים את השלבים הבאים.

  1. מפעילים את הטרמינל של Cloud Shell. כדי להשתמש בסשן עצמאי של Cloud Shell, משתמשים בכתובת shell.cloud.google.com.

  2. יוצרים מופע של Secure Source Manager אם עדיין אין לכם:

    gcloud source-manager instances create INSTANCE_ID \
    --region=LOCATION

    מחליפים את מה שכתוב בשדות הבאים:

    • ‫INSTANCE_ID: המזהה של מופע Secure Source Manager.
    • ‫LOCATION: האזור שבו יוצרים את המכונה, לדוגמה us-central1.

    יצירת המכונה יכולה להימשך עד 60 דקות.

  3. כדי לגשת למופע של Secure Source Manager דרך ממשק האינטרנט שלו, מעתיקים את כתובת ה-URL הבאה לסרגל הכתובות של הדפדפן:

    INSTANCE_ID-PROJECT_NUMBER.LOCATION.sourcemanager.dev

    מחליפים את PROJECT_NUMBER במספר הפרויקט של המכונה. Google Cloud

  4. יצירת מאגר פרטי:

    gcloud source-manager repos create REPO_ID \
    --instance=INSTANCE_ID \
    --region=LOCATION

    מחליפים את REPO_ID במזהה של מאגר Secure Source Manager.

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

  5. מוסיפים את כלי העזר לאימות של Secure Source Manager להגדרת ה-Git הגלובלית. מידע נוסף מופיע במאמר בנושא הגדרת פרטי הכניסה.

  6. משכפלים את המאגר ל-Cloud Shell:

    git clone https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git

    מחליפים את PROJECT_ID במזהה הפרויקט ב- Google Cloud .

  7. מעבירים את קובץ ההדרכה למאגר שנוצר באופן מקומי:

    mv PATH_TO_TUTORIAL REPO_ID/PATH_TO_TUTORIAL

    מחליפים את הערך ב-PATH_TO_TUTORIAL בנתיב למדריך הפרטי.

  8. עוברים למאגר המקומי:

    cd REPO_ID

  9. מוסיפים, מבצעים קומיט ושולחים את קובצי ההדרכה:

    git add .
git commit -m "Add private tutorial to Secure Source Manager"
git push origin main

  10. אפשר לראות את מאגר Secure Source Manager בממשק האינטרנט. מידע נוסף זמין במאמר בנושא הצגה של רשימת מאגרי מידע.

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

כדי להשתמש במדריך שמתארח במאגר Secure Source Manager, צריך להגדיר את הפרמטר cloudshell_git_repo עם כתובת ה-HTTPS של המאגר. לדוגמה:

https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git

אתם יכולים לעצב את הקישור הזה ככפתור ולהטמיע אותו במסמכי התיעוד כדי שהמשתמשים יוכלו למצוא אותו. לדוגמה:

[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://INSTANCE_ID-PROJECT_NUMBER-git.LOCATION.sourcemanager.dev/PROJECT_ID/REPO_ID.git)

התאמה אישית של מדריכים באמצעות כלי תוספים

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

כדי לעשות את זה, אפשר ליצור קובץ אימג' של Docker שמתפקד כסביבת Cloud Shell מותאמת אישית עם כל החבילות הנוספות וההגדרות המותאמות אישית שרוצים להפוך לזמינות למשתמש.