Escribir un tutorial - Cloud Shell - Centro de documentación de Alibaba Cloud

Cree y publique tutoriales interactivos en Cloud Shell para ayudar a los usuarios a comenzar con su proyecto.

Haga clic en Cloud Shell tutorial mode para abrir un ejemplo en vivo. En el modo tutorial, haga clic en cualquier comando de la documentación para ejecutarlo directamente en Cloud Shell.

Paso 1: Cree un archivo de tutorial

En Cloud Shell, cree un directorio para los documentos de su tutorial.

Ejemplo
```
mkdir tutorials
```
En el nuevo directorio, cree un archivo Markdown, por ejemplo tutorial.md.
```
touch tutorial.md
```

Paso 2: Escribir el tutorial

Redacte su tutorial con sintaxis Markdown y siga estas convenciones:

Use un encabezado H1 (#) para el título del tutorial. Cada documento de tutorial solo puede tener un encabezado H1.
Use un encabezado H2 (##) para el título de cada paso.
Agregue fragmentos de código mediante la sintaxis de código de Markdown. Cloud Shell los muestra como bloques de código con un botón de copia; al hacer clic en él, el comando se pega directamente en la terminal de Cloud Shell.
```
aliyun help 
```
Use la directiva <tutorial-nav> para generar una estructura de navegación en su tutorial.
```
<tutorial-nav></tutorial-nav>
```
Use la directiva <tutorial-editor-open-file> para agregar un enlace que abra un archivo específico en el editor de texto de Cloud Shell.
```
<tutorial-editor-open-file filePath="path/test.md">Open File</tutorial-editor-open-file>
```
El archivo debe encontrarse en el directorio $HOME o en uno de sus subdirectorios. El atributo filePath acepta una ruta absoluta o relativa. Cloud Shell resuelve las rutas relativas tomando como base el directorio $HOME.

Tome el siguiente ejemplo como referencia al redactar su tutorial. Escríbalo con el comando vim o con el editor de texto de 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.

Paso 3: Publicar el tutorial

Antes de ejecutar git push, previsualice y pruebe su tutorial con el siguiente 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

Use los comandos Git integrados en Cloud Shell para enviar su tutorial a un repositorio Git remoto.

Nota
Su repositorio Git debe ser público. Si es privado, los usuarios no podrán clonarlo en Cloud Shell.