Todos os produtos
Search
Central de documentação

Cloud Shell:Write a tutorial

Última atualização: Jun 28, 2026

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

  1. No Cloud Shell, crie um diretório para os documentos do seu tutorial.

    Exemplo

    mkdir tutorials
  2. 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 $HOME ou em um de seus subdiretórios. O atributo filePath aceita 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

  1. Antes de executar git push, visualize e teste seu tutorial com o seguinte comando.

    teachme tutorial.md
    shell@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
  2. Utilize os comandos Git integrados no Cloud Shell para enviar seu tutorial para um repositório Git remoto.

    Nota

    Seu repositório Git deve ser público. Se for privado, os usuários não poderão cloná-lo no Cloud Shell.

Instruções

  1. Leia o conteúdo em inglês para entender O QUE precisa ser comunicado

  2. Escreva o português brasileiro DO ZERO — esqueça a estrutura das frases em inglês

  3. Preserve toda a formatação markdown, blocos de código, links e imagens exatamente como estão

  4. 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 > e

  5. Aplique todas as regras específicas do idioma rigorosamente

  6. Aplique as regras de stopwords com tolerância zero

  7. Use o modo imperativo em etapas numeradas e listas de procedimentos

  8. Garanta consistência terminológica — mesmo termo = mesma tradução em todo o documento

  9. Varie os inícios de frase em listas/tabelas — nenhum início repetido 3+ vezes

  10. Retorne APENAS o documento markdown em português brasileiro, sem explicações