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 tutoriales en contexto a partir de estos archivos de Markdown analizando el texto en pasos y subpasos que luego se muestran en un panel en la consola de Google Cloud.
Obtén más información sobre los instructivos (a través de un instructivo)
Para aprender sobre los tutoriales interactivos trabajando en un video interactivo real comienza el instructivo sobre cómo escribir instructivos con el siguiente botón:
Escribe instructivos
Los tutoriales están escritos en CommonMark Markdown. Se admiten extensiones de Markdown adicionales, al igual que directivas, que incluyen funciones avanzadas, como funciones de destaque y la adición de íconos intercalados.
Pasos
Al crear un tutorial, los encabezados son importantes para determinar su estructura. Para definir el título, los encabezados y las instrucciones subyacentes correctos, utiliza la siguiente jerarquía:
- H1 (#) etiquetas para el título del instructivo. Solo debe haber 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 funciones y agregar íconos intercalados.
Para agregar una directiva, usa este formato:
<walkthrough-DIRECTIVE_NAME PARAMETER="PARAMETER_VALUE">
</walkthrough-DIRECTIVE_NAME>
Por ejemplo, si deseas usar la directiva editor-open-file
y las
parámetro filePath
, se escribiría de la siguiente manera:
<walkthrough-editor-open-file filePath="test/hello.md">
</walkthrough-editor-open-file>
Para conocer las directivas disponibles, consulta el referencia de las directivas.
Iniciar instructivos en Cloud Shell
Hay dos formas de iniciar una explicación en Cloud Shell:
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
Usa Abrir en Cloud Shell
Como alternativa, puedes usar el Abrir en Cloud Shell para guiar a los usuarios de un sitio web, blog o proyecto de código abierto a tu instructivo alojado en un repositorio de Git. El La función Abrir en Cloud Shell permite una
cloudshell_tutorial
, que se puede agregar al final de la URL para especificar la ubicación del archivo fuente de Markdown en el repositorio. Esta significa que el Markdown de un botón vinculado a tu instructivo se vería así:[![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
- Para ver una lista completa de las expresiones de Markdown específicas, en relación con instructivos, consulta las Referencias de Markdown para instructivos.
- Si deseas obtener instrucciones para escribir instructivos eficaces, consulta la Guía de estilo de instructivos.