Créez et publiez des tutoriels interactifs dans Cloud Shell pour aider les utilisateurs à prendre en main votre projet.
Cliquez sur Mode tutoriel de Cloud Shell pour voir un exemple en direct. En mode tutoriel, cliquez sur n'importe quelle commande de la documentation pour l'exécuter directement dans Cloud Shell.
Étape 1 : Créer un fichier de tutoriel
-
Dans Cloud Shell, créez un répertoire pour vos documents de tutoriel.
Exemple
mkdir tutorials -
Dans ce nouveau répertoire, créez un fichier Markdown, par exemple
tutorial.md.touch tutorial.md
Étape 2 : Rédiger le tutoriel
Rédigez votre tutoriel en syntaxe Markdown en respectant les conventions suivantes :
Utilisez un titre H1 (
#) pour le titre du tutoriel. Chaque document ne doit contenir qu'un seul titre H1.Utilisez un titre H2 (
##) pour le titre de chaque étape.-
Ajoutez des extraits de code avec la syntaxe Markdown. Cloud Shell les affiche sous forme de blocs de code accompagnés d'un bouton de copie qui colle la commande directement dans le terminal Cloud Shell.
aliyun help -
Utilisez la directive
<tutorial-nav>pour générer la structure de navigation de votre tutoriel.<tutorial-nav></tutorial-nav> -
Utilisez la directive
<tutorial-editor-open-file>pour ajouter un lien ouvrant un fichier spécifique dans l'éditeur de texte Cloud Shell.<tutorial-editor-open-file filePath="path/test.md">Open File</tutorial-editor-open-file>Le fichier doit se trouver dans le répertoire
$HOMEou dans l'un de ses sous-répertoires. L'attributfilePathaccepte un chemin absolu ou relatif. Cloud Shell résout le chemin relatif par rapport au répertoire$HOME.
Inspirez-vous de l'exemple suivant pour rédiger votre tutoriel. Utilisez la commande vim ou l'éditeur de texte Cloud Shell.
# Manage cloud resources using Alibaba Cloud CLI
## View Alibaba Cloud CLI help
aliyun help
### First Description
### Then Description
echo world
## Congratulations on completing the tutorial
Congratulations! You have completed the tutorial on how to use Alibaba Cloud CLI.
Étape 3 : Publier le tutoriel
-
Avant d'exécuter
git push, prévisualisez et testez votre tutoriel avec la commande suivante.teachme tutorial.mdshell@Alicloud:~/tutorials$ cat tutorial.md # Manage cloud resources using Alibaba Cloud CLI ## View Alibaba Cloud CLI help aliyun help ### First Description ### Then Description echo world ## Congratulations on completing the tutorial Congratulations! You have completed the tutorial on how to use Alibaba Cloud CLI. shell@Alicloud:~/tutorials$ teachme tutorial.md -
Utilisez les commandes Git intégrées à Cloud Shell pour pousser votre tutoriel vers un dépôt Git distant.
RemarqueVotre dépôt Git doit être public. S'il est privé, les utilisateurs ne pourront pas le cloner dans Cloud Shell.