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 kontextbezogene Anleitungen aus diesen Markdown-Dateien, indem sie den Text in Schritte und Teilschritte parsen, die dann in einem Steuerfeld in der Google Cloud Console angezeigt werden.

Anleitung in Cloud Shell

Lernen Sie Anleitungen (mithilfe einer Anleitung)

Starten Sie die Anleitung zum Schreiben von Anleitungen mit der folgenden Schaltfläche, um durch interaktive Anleitungen die interaktive Anleitung zu erlernen:

In Cloud Shell öffnen

Tutorials schreiben

Anleitungen werden im Artikel CommonMark Markdown geschrieben. Zusätzliche Markdown-Erweiterungen werden ebenso wie Anweisungen mit erweiterten Funktionen wie Spotlighting-Funktionen unterstützt. und Inline-Symbole einfügen.

Schritte

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

  • H1 (#)-Tags für den Titel der Anleitung: Eine 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 Features 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 sie 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 in Ihrer Cloud Shell-Sitzung den folgenden cloudshell-Befehl 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. Führen Sie dazu den folgenden Befehl in Ihrer Cloud Shell-Sitzung aus, um eine Anleitung aus der vorhandenen Datei hello.md zu starten. :

    teachme hello.md
    
  2. In Cloud Shell öffnen

    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 Ihrem In einem Git-Repository gehostete Anleitung Die Funktion In Cloud Shell öffnen ermöglicht den Parameter cloudshell_tutorial, der an das Ende der URL angehängt werden kann, um den Speicherort der Markdown-Quelldatei anzugeben. im Repository fest. Dies bedeutet, dass die Schaltfläche "Markdown" für eine Schaltfläche, die mit Ihrer Anleitung verknüpft ist, wie folgt 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)
    

Mehr zur Verwendung der Play Console erfahren