Crea instructivos privados en Cloud Shell

Cloud Shell admite la creación de instructivos privados, lo que te permite diseñar instructivos específicamente para tu público.

Después de escribir instructivos con la guía Cómo escribir instructivos en Cloud Shell y seguir las prácticas recomendadas que se detallan en la Guía de estilo de instructivos, puedes alojar tu instructivo en un repositorio de Git privado para que esté disponible para tus usuarios.

Alojar instructivos privados

Para que tu instructivo sea privado, necesitas un repositorio de Git privado para alojarlo. Puedes usar el servicio de hosting de repositorios de Git que prefieras. En esta guía, se usan Cloud Source Repositories, repositorios privados de Git alojados en Google Cloud.

Para crear un repositorio de Cloud Source Repositories que aloje tu guía privada, sigue estos pasos:

  1. Inicia la terminal de Cloud Shell. Para una sesión independiente de Cloud Shell, usa shell.cloud.google.com.

  2. Crea un repositorio privado:

    gcloud source repos create REPO_NAME

  3. Clona tu repositorio en Cloud Shell:

    gcloud source repos clone REPO_NAME

  4. Mueve el archivo del instructivo al repositorio que creaste de forma local:

    mv PATH/TO/TUTORIAL REPO_NAME/PATH/TO/TUTORIAL

  5. Ve a tu repositorio local:

    cd REPO_NAME

  6. Agrega el instructivo a la confirmación:

    git add .

  7. Confirma los archivos en el repositorio con un comentario que describa el historial de esta acción:

    git commit -m "Add private tutorial to Cloud Source Repositories"

  8. Usa el comando git push para agregar el contenido del repositorio de Git local a Cloud Source Repositories:

    git push origin master

  9. Visualiza tu repositorio y su contenido en la consola de Google Cloud:

    Abrir Cloud Source Repositories

Para ayudar a los usuarios a llegar a tu instructivo, puedes usar la función Abrir en Cloud Shell de Cloud Shell, que te permite definir cómo los usuarios acceden a tu instructivo. Para obtener detalles sobre cómo personalizar tu vínculo, consulta la Guía de Open in Cloud Shell.

Para un instructivo alojado en un repositorio de Cloud Source Repositories, deberás definir el parámetro cloudshell_git_repo con la URL de tu repositorio.

Ejemplo de un vínculo con cloudshell_git_repo definido:

https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://source.developers.google.com/p/project_name/r/repo_name

Puedes aplicarle diseño a este vínculo como un botón para incorporarlo en tu documentación para que los usuarios lo encuentren fácilmente:

[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://source.developers.google.com/p/project_name/r/repo_name)

Personaliza los instructivos con herramientas complementarias

Puedes personalizar aún más tu experiencia de tutorial privado proporcionando tu a los usuarios con herramientas personalizadas para trabajar con tu instructivo.

Para ello, puedes crear una imagen de Docker que funcione como una imagen entorno de Cloud Shell con todos los paquetes adicionales y de configuración que deseas que estén disponibles para tu usuario. Para obtener detalles sobre cómo crear una imagen de contenedor personalizada y actualizar la ventana para hacer referencia a esta imagen de contenedor, consulta la Guía para personalizar imágenes de contenedor