Crie e publique tutoriais interativos no Cloud Shell para ajudar os usuários a começar a usar seu projeto.
Clique em Cloud Shell tutorial mode para ver um exemplo ao vivo. No modo de tutorial, clique em qualquer comando da documentação para executá-lo diretamente no Cloud Shell.
Etapa 1: Crie um arquivo de tutorial
-
No Cloud Shell, crie um diretório para os documentos do seu tutorial.
Exemplo
mkdir tutorials -
No novo diretório, crie um arquivo Markdown, como
tutorial.md.touch tutorial.md
Etapa 2: Escreva o tutorial
Escreva seu tutorial usando a sintaxe Markdown e siga estas convenções:
Utilize um título H1 (
#) para o título do tutorial. Cada documento de tutorial pode ter apenas um título H1.Use um título H2 (
##) para o título de cada etapa.-
Adicione trechos de código com a sintaxe de código do Markdown. O Cloud Shell os renderiza como blocos de código com um botão de cópia — ao clicar nele, o comando é colado diretamente no terminal do Cloud Shell.
aliyun help -
Empregue a diretiva
<tutorial-nav>para gerar uma estrutura de navegação para o seu tutorial.<tutorial-nav></tutorial-nav> -
Aplique a diretiva
<tutorial-editor-open-file>para adicionar um link que abre um arquivo específico no editor de texto do Cloud Shell.<tutorial-editor-open-file filePath="path/test.md">Open File</tutorial-editor-open-file>O arquivo deve estar no diretório
$HOMEou em um de seus subdiretórios. O atributofilePathaceita um caminho absoluto ou relativo. O Cloud Shell resolve caminhos relativos tomando como base o diretório$HOME.
Tome o exemplo a seguir como referência ao escrever seu tutorial. Edite-o usando o comando vim ou o editor de texto do Cloud Shell.
# Manage cloud resources using Alibaba Cloud CLI
## View Alibaba Cloud CLI help
aliyun help
### First Description
### Then Description
echo world
## Congratulations on completing the tutorial
Congratulations! You have completed the tutorial on how to use Alibaba Cloud CLI.
Etapa 3: Publique o tutorial
-
Antes de executar
git push, visualize e teste seu tutorial com o seguinte comando.teachme tutorial.mdshell@Alicloud:~/tutorials$ cat tutorial.md # Manage cloud resources using Alibaba Cloud CLI ## View Alibaba Cloud CLI help aliyun help ### First Description ### Then Description echo world ## Congratulations on completing the tutorial Congratulations! You have completed the tutorial on how to use Alibaba Cloud CLI. shell@Alicloud:~/tutorials$ teachme tutorial.md -
Utilize os comandos Git integrados no Cloud Shell para enviar seu tutorial para um repositório Git remoto.
NotaSeu repositório Git deve ser público. Se for privado, os usuários não poderão cloná-lo no Cloud Shell.
Instruções
Leia o conteúdo em inglês para entender O QUE precisa ser comunicado
Escreva o português brasileiro DO ZERO — esqueça a estrutura das frases em inglês
Preserve toda a formatação markdown, blocos de código, links e imagens exatamente como estão
Tags xref (
<a data-tag="xref" ...>texto</a>) — preserve a tag INTEIRA com todos os atributos na ordem e caixa originais, traduza APENAS o texto visível entre > eAplique todas as regras específicas do idioma rigorosamente
Aplique as regras de stopwords com tolerância zero
Use o modo imperativo em etapas numeradas e listas de procedimentos
Garanta consistência terminológica — mesmo termo = mesma tradução em todo o documento
Varie os inícios de frase em listas/tabelas — nenhum início repetido 3+ vezes
Retorne APENAS o documento markdown em português brasileiro, sem explicações