Diese Seite wurde von der Cloud Translation API übersetzt.
Switch to English

Anleitungen in Cloud Shell schreiben

Cloud Shell unterstützt das Erstellen und Starten von Anleitungen, damit sich Nutzer schnell und effektiv mit Ihrem Projekt vertraut machen können.

Eine Anleitung besteht aus einer Reihe von Anleitungen, die in Markdown geschrieben wurden. In Cloud Shell werden aus diesen Markdown-Dateien kontextbezogene Anleitungen erstellt. Dazu werden der Text in Schritte und Teilschritte geparst, die dann in einem Feld in der Google Cloud Console angezeigt werden.

Eine in Cloud Shell ausgeführte Anleitung

Lernen Sie Anleitungen (mithilfe einer Anleitung)

Um interaktive Anleitungen mithilfe einer echten interaktiven Anleitung zu lesen, starten Sie die Anleitung zum Schreiben von Anleitungen mit der folgenden Schaltfläche:

In Google Cloud Shell öffnen

Tutorials schreiben

Anleitungen sind in CommonMark Markdown geschrieben. Es werden zusätzliche Markdown-Erweiterungen sowie Anweisungen unterstützt, die erweiterte Funktionen wie Spotlight-Funktionen enthalten. und fügen Sie Inline-Symbole hinzu.

Schritte

Beim Erstellen einer Anleitung sind Überschriften wichtig, um ihre Struktur zu bestimmen. Verwenden Sie die folgende Hierarchie, um den richtigen Titel sowie die Schrittüberschriften und zugrunde liegenden Anleitungen festzulegen:

  • H1 (#)-Tags für den Titel der Anleitung: Jede Anleitung sollte nur ein H1-Tag enthalten.
  • H2 (##)-Tags für eine Schrittüberschrift
  • H3 (###)-Tags für die Überschrift eines Unterschritts

Mithilfe der folgenden Markdown-Beispieldatei können Sie eine Anleitung erstellen:

# First tutorial

## First step

Hello world

### Part 1

Part one instructions.

### Part 2

Part two instructions.

## Conclusion

Done!

Anweisungen

Anweisungen ermöglichen erweiterte Funktionen wie das Hervorheben von Merkmalen und das Einfügen von Inline-Symbolen.

Verwenden Sie das folgende Format, um eine Anweisung hinzuzufügen:

<walkthrough-DIRECTIVE_NAME PARAMETER="PARAMETER_VALUE">
</walkthrough-DIRECTIVE_NAME>

Wenn Sie beispielsweise die Anweisung editor-open-file und den Parameter filePath verwenden möchten, würde dies so geschrieben werden:

<walkthrough-editor-open-file filePath="test/hello.md">
</walkthrough-editor-open-file>

Informationen zu den verfügbaren Anweisungen finden Sie in der Referenz zu Anweisungen.

Anleitungen in Cloud Shell starten

Es gibt zwei Möglichkeiten, eine Anleitung in Cloud Shell zu starten:

  1. Den Befehl cloudshell launch-tutorial ausführen

    Führen Sie den folgenden cloudshell-Befehl in Ihrer Cloud Shell-Sitzung aus, um eine Anleitung aus der Markdown-Datei tutorial.md zu starten:

    cloudshell launch-tutorial tutorial.md
    

    Alternativ können Sie den Alias teachme verwenden, indem Sie in Ihrer Cloud Shell-Sitzung den folgenden Befehl ausführen, um eine Anleitung aus einer vorhandenen Datei (hello.md) zu starten. :

    teachme hello.md
    
  2. In Cloud Shell öffnen

    Alternativ können Sie mit der Funktion In Cloud Shell öffnen Nutzer von einer Website, einem Blog oder einem Open-Source-Projekt an Ihre in einem Git-Repository gehostete Anleitung. Die Funktion In Cloud Shell öffnen ermöglicht den Parameter cloudshell_tutorial, den am Ende der URL eingefügt werden kann, um den Speicherort der Markdown-Quelldatei anzugeben. im Repository. Dies bedeutet, dass die Markdown-Schaltfläche für eine mit Ihrer Anleitung verknüpfte Schaltfläche so aussieht:

    [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.png)](https://ssh.cloud.google.com/cloudshell/open?cloudshell_git_repo=GIT_REPO_URL&cloudshell_tutorial=PATH_TO_MD_FILE)
    

Tipp