Escribe instructivos en Cloud Shell

Cloud Shell admite la compilación y el lanzamiento de instructivos llamados explicaciones, que ayudan a que los usuarios se familiaricen de forma rápida y eficaz con tu proyecto.

Una explicación es un conjunto de instrucciones escritas con Markdown. Cloud Shell crea instructivos en contexto a partir de estos archivos de Markdown, ya que analiza el texto en pasos y pasos secundarios que luego se muestran en un panel en Google Cloud Console.

Un instructivo que se ejecuta en Cloud Shell

Obtén información sobre los instructivos (con un instructivo).

Para aprender sobre los instructivos interactivos mediante el trabajo de un instructivo interactivo real, inicia el instructivo sobre cómo escribir instructivos con el siguiente botón:

Abrir en Cloud Shell

Escribe instructivos

Los instructivos se escriben en CommonMark Markdown. Se admiten extensiones de Markdown adicionales, como las directivas, que incluyen funciones avanzadas, como funciones destacadas, y que se agregan íconos intercalados.

Pasos

Cuando creas un instructivo, los encabezados son importantes para determinar su estructura. Para establecer el título, los encabezados de pasos y las instrucciones subyacentes correctas, usa la siguiente jerarquía:

  • H1 (#) etiquetas para el título del instructivo. Debe haber solo una etiqueta H1 en un instructivo.
  • H2 (##) etiquetas para un título secundario.
  • H3 (###) etiquetas para un título terciario.

Este es un archivo de muestra de Markdown que puedes usar para crear un instructivo:

# First tutorial

## First step

Hello world

### Part 1

Part one instructions.

### Part 2

Part two instructions.

## Conclusion

Done!

Directivas

Las directivas habilitan funciones avanzadas, como destacar características y agregar íconos intercalados.

Para agregar una directiva, usa este formato:

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

Por ejemplo, si quieres usar la directiva editor-open-file y el parámetro filePath, se escribiría de la siguiente manera:

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

Para ver las directivas disponibles, consulta la referencia de directivas.

Iniciar instructivos en Cloud Shell

Hay dos formas de iniciar una explicación en Cloud Shell:

  1. Usa el comando cloudshell launch-tutorial

    Ejecuta el siguiente comando cloudshell en tu sesión de Cloud Shell para iniciar un instructivo desde un archivo existente de Markdown, tutorial.md:

    cloudshell launch-tutorial tutorial.md
    

    Alternativamente, puede usar el alias teachme ejecutando el siguiente comando en su sesión de Cloud Shell para iniciar un instructivo desde un archivo existente, hello.md:

    teachme hello.md
    
  2. Usa Abrir en Cloud Shell

    Como alternativa, puedes usar la función Abrir en Cloud Shell para guiar a los usuarios desde un sitio web, blog o proyecto de código abierto a tu instructivo alojado en un repositorio de Git. La función Abrir en Cloud Shell permite un parámetro cloudshell_tutorial, que se puede agregar al final de la URL para especificar la ubicación del archivo Markdown de origen en el repositorio. Eso significa que así se vería la Markdown de un botón vinculado a tu instructivo:

    [![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óximos pasos