Private Anleitungen in Cloud Shell erstellen

Mit Cloud Shell können Sie private Anleitungen erstellen, sodass Sie Anleitungen speziell für Ihre Zielgruppe erstellen können.

Nachdem Sie Anleitungen mithilfe der Anleitung Anleitungen in Cloud Shell schreiben erstellt und den im Leitfaden zum Styleguide beschriebenen Best Practices gefolgt sind: Sie können Ihre Anleitung in einem privaten Git-Repository hosten, um sie Ihren Nutzern zur Verfügung zu stellen.

Private Anleitungen hosten

Damit Ihre Anleitung privat wird, benötigen Sie ein privates Git-Repository, in dem sie gehostet werden kann. Sie können einen beliebigen Git-Repository-Hostingdienst verwenden. In dieser Anleitung wird Cloud Source Repositories verwendet, private Git-Repositories, die in Google Cloud gehostet werden

So erstellen Sie ein Cloud Source Repositories-Repository zum Hosten Ihrer privaten Anleitung:

  1. Starten Sie das Cloud Shell-Terminal. Verwenden Sie für eine eigenständige Cloud Shell-Sitzung shell.cloud.google.com.
  2. Erstellen Sie ein privates Repository:

    gcloud source repos create REPO_NAME
    
  3. Klonen Sie Ihr Repository in Cloud Shell:

    gcloud source repos clone REPO_NAME
    
  4. Verschieben Sie Ihre Anleitungsdatei in Ihr lokal erstelltes Repository:

    mv PATH/TO/TUTORIAL REPO_NAME/PATH/TO/TUTORIAL
    
  5. Rufen Sie Ihr lokales Repository auf:

    cd REPO_NAME
    
  6. Fügen Sie die Anleitung hinzu, für die ein Commit durchgeführt werden soll:

    git add .
    
  7. Führen Sie für die Dateien ein Commit zum Repository durch, mit einem Kommentar, der den Verlauf dieser Aktion beschreibt:

    git commit -m "Add private tutorial to Cloud Source Repositories"
    
  8. Fügen Sie den Inhalt des lokalen Repositorys mit dem Befehl git push Cloud Source Repositories hinzu:

    git push origin master
    
  9. Rufen Sie Ihr Repository und seinen Inhalt in der Google Cloud Console auf:

    Cloud Source Repositories öffnen

Damit Ihre Nutzer Ihre Anleitung erreichen können, können Sie die Cloud Shell-Funktion "In Cloud Shell öffnen" verwenden, mit der Sie definieren können, wie Nutzer auf Ihre Anleitung zugreifen. Weitere Informationen zum Anpassen des Links finden Sie in der Anleitung zum Öffnen in Cloud Shell.

Für eine Anleitung, die in einem Cloud Source Repositories-Repository gehostet wird, müssen Sie den Parameter cloudshell_git_repo mit der URL Ihres Repositorys definieren.

Beispiel für einen Link mit definiertem cloudshell_git_repo:

https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://source.developers.google.com/p/project_name/r/repo_name

Sie können diesen Link als Schaltfläche integrieren, um ihn in Ihre Dokumentation einzubetten, damit die Nutzer sie einfach finden können:

[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://source.developers.google.com/p/project_name/r/repo_name)

Anleitungen mit Add-on-Tools anpassen

Sie können die privaten Anleitungen weiter anpassen, indem Sie Ihren Nutzern benutzerdefinierte Tools bereitstellen, die mit Ihrer Anleitung arbeiten.

Dazu können Sie ein Docker-Image erstellen, das als benutzerdefinierte Cloud Shell-Umgebung mit allen zusätzlichen Paketen und benutzerdefinierten Konfigurationen dient, die Ihrem Nutzer zur Verfügung gestellt werden. Ausführliche Informationen zum Erstellen eines benutzerdefinierten Container-Images und zum Aktualisieren des Links „In Cloud Shell öffnen” finden Sie im Leitfaden zum Anpassen des Container-Images.