Créer des tutoriels privés dans Cloud Shell

Cloud Shell prend en charge la création de tutoriels privés, ce qui vous permet de concevoir des tutoriels spécifiquement pour votre audience.

Après avoir créé des tutoriels utilisant le guide Écrire des tutoriels dans Cloud Shell et suivi les bonnes pratiques détaillées dans le guide de style du tutoriel, vous pouvez héberger votre tutoriel dans un dépôt Git privé afin de le mettre à la disposition de vos utilisateurs.

Héberger des tutoriels privés

Pour rendre votre tutoriel privé, vous avez besoin d'un dépôt Git privé pour l'héberger. Vous pouvez utiliser n'importe quel service d'hébergement de dépôt Git. Ce guide utilise Cloud Source Repositories, des dépôts Git privés hébergés sur Google Cloud.

Pour créer un dépôt Cloud Source Repositories pour héberger votre tutoriel privé:

  1. Lancez le terminal Cloud Shell. Pour une session Cloud Shell autonome, utilisez shell.cloud.google.com.
  2. Créez un dépôt privé :

    gcloud source repos create REPO_NAME
    
  3. Clonez votre dépôt vers Cloud Shell :

    gcloud source repos clone REPO_NAME
    
  4. Déplacez votre fichier de tutoriel vers le dépôt créé localement :

    mv PATH/TO/TUTORIAL REPO_NAME/PATH/TO/TUTORIAL
    
  5. Accédez à votre dépôt local :

    cd REPO_NAME
    
  6. Ajoutez le tutoriel au commit:

    git add .
    
  7. Procédez au commit des fichiers dans le dépôt en ajoutant un commentaire décrivant l'historique de cette action :

    git commit -m "Add private tutorial to Cloud Source Repositories"
    
  8. À l'aide de la commande git push, ajoutez le contenu du dépôt local dans Cloud Source Repositories :

    git push origin master
    
  9. Affichez votre dépôt et son contenu dans Google Cloud Console:

    Ouvrir Cloud Source Repositories

Pour aider vos utilisateurs à accéder à votre tutoriel, vous pouvez utiliser la fonctionnalité Cloud Shell Open in Cloud Shell qui vous permet de définir la manière dont les utilisateurs accèdent à votre tutoriel. Pour plus d'informations sur la personnalisation de votre lien, consultez le guide Open in Cloud Shell.

Pour un tutoriel hébergé dans un dépôt Cloud Source Repositories, vous devez définir le paramètre cloudshell_git_repo avec l'URL de votre dépôt.

Voici un exemple de lien avec cloudshell_git_repo défini :

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

Vous pouvez personnaliser ce lien en tant que bouton à intégrer dans votre documentation pour permettre aux utilisateurs de trouver facilement :

[![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)

Tutoriels personnalisés avec des outils complémentaires

Vous pouvez personnaliser davantage votre expérience de tutoriel privé en fournissant à vos utilisateurs des outils personnalisés pour travailler avec votre tutoriel.

Pour ce faire, vous pouvez créer une image Docker qui fonctionne comme un environnement Cloud Shell personnalisé avec tous les packages et configurations personnalisés que vous souhaitez mettre à la disposition de votre utilisateur. Pour en savoir plus sur la création d'une image de conteneur personnalisée et sur la mise à jour du lien "Ouvrir dans Cloud Shell" pour référencer cette image de conteneur, consultez le guide Personnaliser l'image de conteneur.