Como criar tutoriais no Cloud Shell

O Cloud Shell oferece suporte à criação e ao lançamento de tutoriais para ajudar os usuários a se familiarizarem com seu projeto de maneira rápida e eficaz.

Um tutorial é um conjunto de instruções escritas no Markdown. O Cloud Shell cria tutoriais no contexto a partir desses arquivos do Markdown por meio da análise do texto em etapas e subetapas que são exibidas em um painel no Console do Google Cloud.

Um tutorial em execução no Cloud Shell

Aprender sobre os tutoriais (usando um tutorial)

Para aprender sobre tutoriais interativos trabalhando com um tutorial interativo real, inicie o tutorial sobre como escrever tutoriais com o seguinte botão:

Abrir no Cloud Shell

Como criar tutoriais

Tutoriais são escritos em CommonMarkdown. Há suporte para outras extensões Markdown, assim como diretivas, que incluem funcionalidades avançadas, como recursos de destaque. e adicionar ícones in-line.

Etapas

Ao criar um tutorial, os cabeçalhos são importantes para determinar sua estrutura. Para definir o título, os cabeçalhos das etapas e as instruções subjacentes corretamente, use a seguinte hierarquia:

  • Tags H1 (#) para o título do tutorial. Só deve haver uma tag H1 em um tutorial.
  • Tags H2 (##) para o título de uma etapa.
  • Tags H3 (###) para o título de uma subetapa.

Veja um exemplo de arquivo do Markdown que você 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 permitem a funcionalidade avançada, como o destaque de recursos e a adição de ícones in-line.

Para adicionar uma diretiva, use o seguinte formato:

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

Por exemplo, se você quiser usar a diretiva editor-open-file e o parâmetro filePath, ela será escrita da seguinte maneira:

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

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

Como abrir tutoriais no Cloud Shell

Há duas maneiras de iniciar um tutorial no Cloud Shell:

  1. Usar 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 arquivo Markdown atual, tutorial.md:

    cloudshell launch-tutorial tutorial.md
    

    Outra opção é usar o alias teachme. Basta executar o seguinte comando na sessão do Cloud Shell para iniciar um tutorial a partir de um arquivo atual, hello.md:

    teachme hello.md
    
  2. Usar Abrir no Cloud Shell

    Como alternativa, você pode usar o recurso Abrir no Cloud Shell para orientar os usuários em um site, blog ou projeto de código aberto para tutorial hospedado em um repositório Git. O recurso Abrir no Cloud Shell permite que um parâmetro cloudshell_tutorial, que pode ser adicionado ao final do URL para especificar o local do arquivo Markdown de origem. no repositório. Isso significa que o Markdown de um botão vinculado ao seu tutorial seria:

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

Próximas etapas