Esta guía describe y demuestra las principales posibilidades que tiene un tutorial de codelabs. En las siguientes páginas podemos explorar cada una de las principales funcionalidades.

Este codelab está basado en la guía oficial ubicada en:

https://github.com/googlecodelabs/tools/blob/main/FORMAT-GUIDE.md

Codelabs nos permite utilizar un documento de google docs para generar un tutorial, siguiendo algunas convenciones en su escritura. En este tutorial aprenderemos algunas de ellas. Para iniciar, cree un documento de google docs (si quiere copiando esta plantilla) y escriba su tutorial en él.

Un codelab debe iniciar con una tabla como la que se muestra al inicio de este documento. En ella se deben especificar los siguientes campos:

• Summary: Un resumen del tutorial
• URL: Sufijo de la url donde el codelab será publicado.
• Category: Categoría del tutorial. Codelabs organiza y agrupa los tutoriales por esa categoría.
• Environment: Especificaciones acerca del ambiente donde se realiza el tutorial
• Status: Estado del tutorial, puede ser Draft, Published, Deprecated o Hidden.
• Feedback Link: Enlace al que se pueden enviar retroalimentaciones sobre el tutorial.
• Author: Autor del codelab

Para delimitar los pasos de un tutorial, se utiliza el formato Heading 1. Todos los títulos que están con este formato, aparecerán en el menú de navegación del tutorial. Para efectos de organizar su contenido, se pueden utilizar los otros encabezados Heading 2, Heading 3 y Heading 4.

Título encabezado 2

Contenido de la sección

Título encabezado 3

Contenido de la sección

Título encabezado 4

Contenido de la sección

Los textos que se escriban en el tutorial se mostrarán en tipografía roboto, independientemente de la tipografía utilizada en el documento. Las negrillas e itálicas serán respectivamente interpretadas. Además, los textos que se escriben utilizando la tipografía Courier New se interpretarán como código fuente.

print("Hola mundo")

Se pueden insertar imágenes en el documento y se verán en el tutorial. Por defecto, estas se acomodarán con el tamaño máximo que se defina en el documento.

Se puede insertar videos de youtube en un tutorial, para ello tendrá que realizar las siguientes acciones:

1. Cree una imagen donde irá el video. Puede ser un pantallazo del mismo.
2. Agregue un texto alternativo a la imagen
3. En el campo de descripción del texto alternativo, pegue el enlace del video que quiere utilizar. El enlace debe tener el formato: https://www.youtube.com/watch?v=[video_ID]

Se puede insertar videos de Microsoft Stream en un tutorial, para ello tendrá que realizar las siguientes acciones:

1. Cree una imagen donde irá el video. Puede ser un pantallazo del mismo.
2. Agregue un texto alternativo a la imagen
3. En el campo de descripción del texto alternativo, pegue el enlace del video que quiere utilizar (Se recomienda utilizar el enlace de embed)
4. Este procedimiento se puede realizar con otros sitios que soporten código embed pero debe agregarse el dominio a la lista de dominios permitidos en el servidor. Para ello se debe contactar a su administrador.

Se pueden incluir cajas de texto para información especial que se requiere resaltar en el tutorial (Advertencias o recomendaciones). Para ello hay dos maneras:

Para representar comandos de consola y porciones de código fuente se pueden utilizar las siguientes maneras:

• Para comandos de consola, utilice una tabla de una sola celda con tipografía Consolas

sudo rm -rf / 

• Para escribir código fuente, utilice una tabla de una sola celda con tipografía Courier New

def pythonFunctionSayHello(name):
    print("Hello "+ name + "!")

Se pueden incluir enlaces y botones de descarga para los enlaces. Para ello se puede:

• Crear un enlace simple en un texto
• Crear un enlace con un botón resaltando el texto con color dark green 1

Para poder visualizar el tutorial sin necesidad de publicarlo, se puede usar una extensión de Google Chrome llamada Preview Codelab.