Scrivi tutorial in Cloud Shell

Cloud Shell supporta la creazione e l'avvio di tutorial per aiutare gli utenti ad acquisire familiarità con il tuo progetto in modo rapido ed efficace.

Un tutorial è un insieme di istruzioni scritte in Markdown. Cloud Shell crea tutorial contestuali a partire da questi file Markdown analizzando il testo in passaggi e sottopassaggi che vengono poi visualizzati in un riquadro della console Google Cloud.

Un tutorial eseguito in Cloud Shell

Scopri di più sui tutorial (con un tutorial)

Per informazioni sui tutorial interattivi, avviali utilizzando il seguente pulsante:

Apri in Cloud Shell

Scrivi tutorial

I tutorial sono scritti in CommonMark Markdown. Sono supportate altre estensioni di Markdown, così come le istruzioni, che includono funzionalità avanzate come le funzionalità di evidenziazione e l'aggiunta di icone incorporate.

Procedura

Quando crei un tutorial, le intestazioni sono importanti per determinarne la struttura. Per impostare il titolo, le intestazioni dei passaggi e le istruzioni sottostanti corretti, utilizza la seguente gerarchia:

  • Tag H1 (#) per il titolo del tutorial. Un tutorial deve contenere un solo tag H1.
  • Tag H2 (##) per il titolo di un passaggio.
  • Tag H3 (###) per il titolo di un passaggio secondario.

Ecco un esempio di file Markdown che puoi utilizzare per creare un tutorial:

# First tutorial

## First step

Hello world

### Part 1

Part one instructions.

### Part 2

Part two instructions.

## Conclusion

Done!

Direttive

Le direttive abilitano funzionalità avanzate come le funzionalità di messa in evidenza e l'aggiunta di icone incorporate.

Per aggiungere un'istruzione, utilizza il formato seguente:

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

Ad esempio, se vuoi utilizzare l'istruzione editor-open-file e il parametro filePath, il codice sarà scritto come segue:

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

Per le istruzioni disponibili, fai riferimento al riferimento alle istruzioni.

Avvia i tutorial in Cloud Shell

Esistono due modi per avviare un tutorial in Cloud Shell:

  1. Utilizzare il comando cloudshell launch-tutorial

    Esegui il seguente comando cloudshell nella sessione di Cloud Shell per avviare un tutorial da un file Markdown esistente, tutorial.md:

    cloudshell launch-tutorial tutorial.md

    In alternativa, puoi utilizzare l'alias teachme eseguendo il comando seguente nella sessione di Cloud Shell per avviare un tutorial da un file esistente, hello.md:

    teachme hello.md

  2. Utilizzare Apri in Cloud Shell

    In alternativa, puoi utilizzare la funzionalità Apri in Cloud Shell per indirizzare gli utenti da un sito web, un blog o un progetto open source al tutorial ospitato in un repository Git. La funzionalità Apri in Cloud Shell consente un parametro cloudshell_tutorial, che può essere aggiunto alla fine dell'URL per specificare la posizione del file Markdown di origine nel repository. Ciò significa che il Markdown per un pulsante collegato al tuo tutorial avrebbe il seguente aspetto:

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

Passaggi successivi