Conventions pour pouvoir travailler ensemble

Convention pour les commandes shell

Dans la suite du cours et des TP, nous utiliserons la convention classique suivante :

les commandes introduites par $ doivent êtres évaluées par un utilisateur non privilégié.

les commandes introduites par # doivent êtres évaluées par l'utilisateur root.

Ces caractères ne font pas partie de la commande, ils servent à signaler quel utilisateur doit lancer la commande. C'est en général le dernier caractère du prompt du shell de l'utilisateur concerné.

Pour lancer une commande <commande> en tant que root, soit vous passez root avec la commande su puis vous tapez la commande <commande>, soit (si sudo est installé et que vous faites partie du groupe sudo) tapez la commande sudo <commande>

L'intérêt de faire commencer les commandes à taper en tant que root par un # est que le shell interprète tout ce qui suit le caractère # comme un commentaire. Ainsi, les personnes qui seraient tentées de copier/coller brutalement une ligne potentiellement dangereuse pour le système (ou dont la souris glisserait en sélectionnant une ligne de trop) seront protégé puisque # <commande> sera compris comme un commentaire par le shell qui n'exécutera pas la commande.

Partager ses messages d'erreur

Les messages d'ereur sont très utiles pour comprendre pourquoi quelque chose ne fonctionne pas. Il est donc important de pouvoir les partager de sorte à faciliter leur utilisation par la personne destinataire :

ne faites pas de copie d'écran de votre terminal (sauf si on vous le demande explicitement). Préférez le texte. En effet, une façon de comprendre ce qui ne marche pas est de copier le message d'erreur dans un moteur de recherche. Avec une copie d'écran, vous imposez à votre interlocuteur·ice de recopier à la main lettre à lettre le message d'erreur.
copiez l'intégralité du message d'erreur, ne le tronquez pas, recopiez aussi la ligne correspondant à la commande tapée, ça permet à votre interlocuteur·ice d'avoir un peu plus de contexte.

Utiliser mattermost

Garder le fil

Les messages de mattermost sont rangés de façon hierarchique (imaginez ce qui se passerait si tous les messages de toutes les personnes de l'université se retrouvaient à la suite les uns des autres).

Ainsi, mattermost est structuré sous forme d'une arborescence de profondeur 4, correspondant aux 4 colonnes de la page web (on en voit que 3 par défaut), de gauche à droite (la racine est à gauche) :

Les équipes, comme BU ou l2-info-2021-22
Les salons (en: channel), comme sysadmin ou Annonces Générales qui sont rattachés à une équipe
Les fils (en: threads), qui sont rattachés à un salon. Un fil correspond à une discussion.
Les messages (en: posts), qui sont rattachés à un fil

Lorsque vous écrivez quelque chose dans un salon mattermost, mattermost crée un nouveau fil. Pour continuer le fil d'une discussion existante, il ne faut pas juste écrire en dessous (ça créerait un nouveau fil), il faut cliquer sur la flèche grise courbée Répondre. À ce moment apparaît une 4e colonne tout à droite qui liste tous les messages du fil. Tant que vous écrivez dans la 4e colonne tout à droite, vous restez dans le fil. Si vous écrivez dans la 3e colonne, vous créez un nouveau fil (sur un nouveau sujet).

Si une personne quitte son fil et en crée un nouveau alors qu'il s'agit de la même discussion, nous pouvons gentiment lui demander de garder son fil, de sorte à ne pas tout mélanger. Ainsi, la personne peut recopier son dernier message dans le fil précédent et supprimer le nouveau fil.

Quel est l'intéret ? Il arrive souvent que plusieurs étudiant·es soient confronté·es aux même problèmes. Le fait que les discussions soient ainsi rangées par fil, permet aux autres étudiant·es de le consulter.

Structurer les discussions en fils permet aussi de garder le contexte dans le temps. Imaginez plein de discussions en parallèle sans structuration en fils, il faudrait remonter pour se souvenir de quoi on parle.

Certains fils peuvent contenir des centaines de messages et s'étaler sur plusieurs jours (lorsqu'un·e étudiant·e a crashé sa machine par exemple), ainsi, avoir rangé tous les messages dans le même fil permet de suivre la discussion au long cours.

Formater les blocs de code

Comme expliqué dans le paragraphe "Partager ses messages d'erreur", il est recommandé de partager vos commandes et messages d'erreur sous forme de texte.

Mattermost utilise le langage de formattage de texte markdown. Consultez le lien Aide en bas à droite de la fenêtre mattermost.

En particulier, si vous entourez un mot avec des étoiles, il sera mis en italique. Le problème lorsqu'on veut partager du code est que si ce code contient des étoiles, elles disparaîtront et le code sera illisible.

Pour que markdown n'interprète pas un bloc de code, il suffit de mettre trois accents graves ou "apostrophe inversées" (en: backquote) avant et après le bloc. Un backquote s'obtient avec la combinaison de touches AltGr+7. Il est même possible de spécifier le langage de programmation utilisé (dans notre cas bash) pour bénéficier de la coloration syntaxique.

Si plusieurs commandes sont mises à la suite, laissez une ligne vide avant chaque nouvelle commande.