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 Markdown, analisando o texto em etapas e subetapas que são exibidas em um painel no console Google Cloud .
Escrever tutoriais
Os tutoriais são escritos em CommonMark Markdown. As extensões de marcação adicionais são compatíveis, assim como as diretivas, que incluem funcionalidades avançadas, como recursos de destaque e ícones inline adicionais.
Etapas
Ao criar um tutorial, os títulos são importantes para determinar a estrutura. Para definir o título correto, os cabeçalhos das etapas e as instruções subjacentes, use a seguinte hierarquia:
- Tags H1 (#) para o título do tutorial. Deve haver apenas 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 funcionalidades avançadas, como destacar recursos e adicionar í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