Kit de survie GitLab en ligne
🌵 Comment créer mon contenu sur mon beau site tout neuf ?
Attention
- Ce tutoriel est destiné aux grands débutants, ne connaisssant pas du tout GitLab.
- Il ne présente que le strict minimum pour être autonome dans la création d'un site.
Travailler en ligne
L'IDE utilisée en ligne est VS Code Web.
Pour composer vos documents, on peut écrire directement dans l'éditeur WEB IDE de la forge et utiliser le bouton «Créer un commit» comme un bouton sauvegarder. La différence par rapport à une sauvegarde «classique» est que vous êtes invités à commenter la ou les modifications apportées afin de créer un historique des modifications successives. Pour les utilisateurs avancés, on peut travailler localement, mais cela sera précisé dans un autre tutoriel.
Configurer la tabulation
En bas à droite, cliquer sur "Select Indentation"
Cliquer ensuite sur "Indent Using Spaces". Sur le menu déroulant qui s'ouvrira, sélectionner 4.
Attention : noms de répertoires et noms de fichiers
Eviter les accents, caractères spéciaux, espaces. Pour séparer les éléments de nommage, utiliser les underscores :
Par exemple : écrire chapitre_intro
I. Ajouter un répertoire dans docs⚓︎
Glisser-déposer
On peut aussi tout simplement glisser-déposer un répertoire ou un fichier à l'endroit voulu.
II. Ajouter un répertoire dans un autre⚓︎
Vous aurez souvent besoin d'ajouter d'autres répertoires comme :
images
a_telecharger
scripts
Glisser-déposer
On peut aussi tout simplement glisser-déposer un répertoire ou un fichier à l'endroit voulu.
III. Créer en ligne un fichier .md ou .py⚓︎
Editeur de texte intégré pour créer des fichiers .md
ou .py
Sur le répertoire désiré, faire un clic droit, puis sélectionner New File
Saisir le nom du fichier que vous désirez créer, sans oublier son extension : par exemple cours_1.md
.
Appuyer sur la touche "entrée" ↵ du clavier pour créer le fichier. Vous pouvez maintenant écrire dans la partie éditeur, à droite.
😊 Ce procédé est utilisable aussi pour écrire un fichier .py
par exemple.
👉 Vous pouvez aussi travailler hors ligne et utiliser un éditeur de texte comme Notepad++ pour créer vos fichiers .md
, puis les télécharger ensuite dans votre dépôt.
Visualiser votre fichier .md
Comment écrire vos pages
👀 Vous pouvez explorer toutes les autres rubriques de ce tutoriel ...
😊 Bonne lecture ...
- Pour les admonitions, liens, vidéos, QCM, exercices, graphes, arbres : une page basique
- Pour les formules en mathématiques et chimies
- Pour les tags
- Pour les fichier pdf
IV. Télécharger un fichier⚓︎
Vous pourrez ainsi télécharger vos fichiers .md
, .py
, .jpg
, .ipynb
, etc.
V. Faire un commit pour un nouveau répertoire, le téléchargement de fichiers, la création d'un fichier⚓︎
Attention
Pour qu'une modification soit réellement effectuée (création de répertoire, modification de fichier ...) il faut faire un commit.
On peut réaliser un seul commit pour plusieurs actions effectuées.
⏳ Attention ... savoir patienter entre deux commits ...
La construction du site après un commit prend quelques instants. Il est vivement conseillé de vérifier sur le rendu du site que les modifications ont été prises en compte, avant de se lancer dans un nouveau commit. Il est parfois nécessaire de rafraichir plusieurs fois la page de rendu du site pour voir les modifications réalisées.
Commit pour nouveau répertoire, téléchargement fichier, ou toute modification sur votre site
Attention
Il ne faut pas faire un commit pour un répertoire qui a été créé, mais est encore vide.
😨 Ce répertoire serait supprimé après le commit.
👉 Suivre cette méthode pour toutes les modifications sur votre site.
👉 Sur la barre d'outil latérale gauche :
👉 Faire le commit :
👉 En bas à droite, Cliquer sur Go to project pour visualiser l'évolution de la construction du site.
Au début, la construction est en cours :
👉 Une fois la construction terminée, on obtient :
👉 Rafraichir la page du rendu de votre site. Il faut attendre un peu, et parfois recommencer, pour voir apparaître les modifications.
Les commits
Un commit, c’est la sauvegarde des modifications, accompagnée d'un commentaire qui résume les modifications effectuées.
Supprimer un commit : 'faire un revert'
Vous pouvez vouloir supprimer un commit pour plusieurs raisons :
- le pipeline n'est pas en échec, mais vous n'avez pas fait ce que vous vouliez
- il a mis le pipeline en échec
👉 Le plus simple est de faire un nouveau commit qui corrige ce que vous voulez.
supprimer des commits
Si vous ne voulez pas faire un nouveau commit, et voulez vraiment réaliser des suppressions de commits, voici comment procéder.
Remarque pour plusieurs commits
Pour supprimer plusieurs commits, il faut les supprimer un à un, en suivant pour chacun la procédure indiquée ci-dessous.
Il s'affiche alors :
Visualiser un commit
VI. Modifier un fichier⚓︎
Modifier un fichier
Réaliser les modifications
Commit pour modification de fichier
On procède comme précédemment.
Observer les modifications
Si les modifications conviennent
Procéder ensuite comme au IV.
VII. Renommer un fichier⚓︎
Attention
Si vous avez renommé un fichier (ou un répertoire) qui était écrit dans un fichier .pages
, modifier ce fichier .pages
avec le nouveau nom, avant de réaliser le commit.
VIII. L'interface Web IDE et le dépôt⚓︎
Pour revenir sur le dépôt (⚠️ attention ne pas oublier de faire un commit s'il y a eu une modification, avant de revenir sur le dépôt)
Tout en bas à gauche :
Puis tout en haut :