Créer des tutoriels privés dans Cloud Shell

Cloud Shell est compatible avec la création de tutoriels privés, ce qui vous permet de concevoir des tutoriels spécialement pour votre audience.

Une fois que vous avez créé des tutoriels à l'aide du guide Écrire des tutoriels dans Cloud Shell et que vous avez suivi les bonnes pratiques détaillées dans le guide de style des tutoriels, peut héberger votre tutoriel dans un dépôt Git privé et 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 le service d'hébergement de dépôt Git que vous préférez. Ce guide utilise Cloud Source Repositories. Dépôts Git privés hébergés sur Google Cloud

Pour créer un dépôt Cloud Source Repositories permettant d'héberger votre tutoriel privé, procédez comme suit:

  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 le fichier du tutoriel vers votre 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 à valider:

    git add .
    
  7. Validez les fichiers dans le dépôt avec 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 à 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 ouverte dans Cloud Shell qui vous permet de définir la façon dont les utilisateurs accèdent à votre tutoriel. Pour savoir comment personnaliser votre lien, consultez le guide Ouvrir dans 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.

Exemple de lien pour lequel cloudshell_git_repo est 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 mettre en forme ce lien sous forme de bouton à intégrer à votre documentation afin que les utilisateurs puissent 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)

Personnaliser des tutoriels avec des outils complémentaires

Vous pouvez personnaliser votre expérience de tutoriel privé en fournissant à vos utilisateurs des outils personnalisés pour l'exploiter.

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 mettre à jour votre lien "Ouvrir dans Cloud Shell" afin de référencer cette image de conteneur, consultez le guide Personnaliser une image de conteneur.