Escreva tutoriais no Cloud Shell

O Cloud Shell suporta a criação e o lançamento de tutoriais para ajudar os utilizadores a familiarizarem-se com o seu projeto de forma rápida e eficaz.

Um tutorial é um conjunto de instruções escritas em Markdown. O Cloud Shell cria tutoriais no contexto a partir destes ficheiros Markdown analisando o texto em passos e subpassos que são, em seguida, apresentados num painel na consola. Google Cloud

Um tutorial em execução no Cloud Shell

Escrever tutoriais

Os tutoriais são escritos em CommonMark Markdown. São suportadas extensões de Markdown adicionais, bem como diretivas, que incluem funcionalidades avançadas, como destacar funcionalidades e adicionar ícones inline.

Passos

Ao criar um tutorial, os títulos são importantes para determinar a sua estrutura. Para definir o título, os títulos dos passos e as instruções subjacentes corretos, use a seguinte hierarquia:

  • Etiquetas H1 (#) para o título do tutorial. Só deve existir uma etiqueta H1 num tutorial.
  • Etiquetas H2 (##) para o título de um passo.
  • Etiquetas H3 (###) para o título de um subpasso.

Segue-se um ficheiro Markdown de exemplo que pode usar para criar um tutorial:

# First tutorial

## First step

Hello world

### Part 1

Part one instructions.

### Part 2

Part two instructions.

## Conclusion

Done!

Diretivas

As diretivas ativam funcionalidades avançadas, como destacar funcionalidades e adicionar ícones inline.

Para adicionar uma diretiva, use o seguinte formato:

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

Por exemplo, se quiser usar a diretiva editor-open-file e o parâmetro filePath, escreveria da seguinte forma:

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

Para ver as diretivas disponíveis, consulte a referência de diretivas.

Inicie tutoriais no Cloud Shell

Existem duas formas de iniciar um tutorial no Cloud Shell:

  1. Use o comando cloudshell launch-tutorial

    Execute o seguinte comando cloudshell na sua sessão do Cloud Shell para iniciar um tutorial a partir de um ficheiro Markdown existente, tutorial.md:

    cloudshell launch-tutorial tutorial.md

    Em alternativa, pode usar o alias teachme executando o seguinte comando na sua sessão do Cloud Shell para iniciar um tutorial a partir de um ficheiro existente, hello.md:

    teachme hello.md

  2. Use a opção Abrir no Cloud Shell

    Em alternativa, pode usar a funcionalidade Abrir no Cloud Shell para orientar os seus utilizadores a partir de um Website, um blogue ou um projeto de código aberto para o seu tutorial alojado num repositório Git. A funcionalidade Abrir no Cloud Shell permite um parâmetro cloudshell_tutorial, que pode ser adicionado ao final do URL para especificar a localização do ficheiro Markdown de origem no repositório. Isto significa que o Markdown para um botão com um link para o seu tutorial teria o seguinte aspeto:

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

Passos seguintes