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. Cloud Shell erstellt aus diesen Markdown-Dateien kontextbezogene Anleitungen, indem der Text geparst und dann in Schritte und Unterschritte unterteilt wird. Diese werden dann in einem Steuerfeld in der Google Cloud Console angezeigt.

Screenshot: Eine in Cloud Shell ausgeführte Anleitung

Anleitungen schreiben

Anleitungen werden in CommonMark Markdown geschrieben. Zusätzliche Markdown-Erweiterungen werden ebenso wie Anweisungen unterstützt, die erweiterte Funktionen wie Hervorhebungsfeatures und das Hinzufügen von Inline-Symbolen enthalten.

Schritte

Beim Erstellen einer Anleitung sind Überschriften zum Festlegen der Struktur wichtig. Verwenden Sie die folgende Hierarchie, um den richtigen Titel, die Schrittüberschriften und die zugrunde liegende Anleitung festzulegen:

  • H1 (#)-Tags für den Titel der Anleitung: Eine Anleitung sollte nur einen H1-Tag haben.
  • 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 Features und das Hinzufü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>

Die verfügbaren Anweisungen finden Sie in der Anweisungsreferenz.

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 den folgenden Befehl in Ihrer Cloud Shell-Sitzung ausführen, um eine Anleitung aus einer vorhandenen Datei, hello.md, zu starten:

    teachme hello.md

  2. In Cloud-Shell öffnen verwenden

    Alternativ können Sie die Funktion In Cloud Shell öffnen verwenden, um Ihre Nutzer von einer Website, einem Blog oder einem Open-Source-Projekt zu Ihrer Anleitung zu leiten, die in einem Git gehostet wird. Die Funktion In Cloud Shell öffnen ermöglicht den Parameter cloudshell_tutorial, der am Ende der URL hinzugefügt werden kann, um den Speicherort der Quell-Markdown-Datei im Repository anzugeben. Der Markdown-Code für eine mit Ihrer Anleitung verknüpfte Schaltfläche sieht demnach so aus:

    [![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)

Weitere Informationen