1. Gestion de projet et documentation#

Cette semaine, on a été initié à la création de notre site web à l’aide de commande unix en utilisant Git ainsi que d’un éditeur de texte pour la mise en page de la documentation. Je pense que ces compétences seront très utiles pour le futur quand j’entrerai dans le monde du professionnel. C’est à l’aide de ces compétences que je vais documenter sur cette page mon apprentissage au cours des semaines de module en module.

Techniques de gestion de projet#

Afin de gérer ses projets, il existe plusieurs manières de s’organiser. Les techniques que je vais utiliser pour ce cours sont les suivantes :

  • As-You-Work Documentation : Consiste à documenter son travail dès le début et à le continuer au fur et à mesure que le travail progresse. C’est utile pour ne rien oublier grâce au court laps de temps entre l’apprentissage et la documentation.
  • Modular & Hierarchical Planning : Concrètement, cela consiste à séparer le travail en différentes petites tâches à accomplir et à les classer par ordre d’importance. Cela permet de visualiser son travail d’une manière bien plus abordable et non comme une grosse tâche complexe à réaliser.
  • Triage : Cette méthode consiste à donner la priorité aux tâches les plus importantes ainsi que les plus urgentes à terminer en fonction du temps qu’il reste.

Outils utilisés#

Les différents outils que j’ai utilisés pour rédiger ce module et que j’utiliserai pour faire les prochains modules sont les suivants :

Installation de Git#

Tout d’abord, j’ai installé Git via ce lien.

Comme j’utilise Windows, j’ai cliqué sur la version Windows puis j’ai installé la version la plus récente.

Configurer Git#

Lier son compte Gitlab#

Une fois Git installé, je me suis identifié via mon nom d’utilisateur et mon email correspondant à mon compte Gitlab. Pour se faire, j’ai ouvert la boite de commande Git et j’ai entré la commande git config --global user.name "your_username" avec votre nom d’utilisateur entre guillemets. Attention cependant à ne pas entrer votre nom d’utilisateur qui est de la forme prénom.nom mais bien votre nom complet.

Lorsque j’avais entré mon nom d’utilisateur (edwin.vanlanduyt), j’avais eu des problèmes par la suite quand j’ai essayé de cloner mon projet. Par contre, quand j’ai entré mon nom complet que vous pouvez voir en gras sur l’image (Edwin Van Landuyt), je n’ai plus eu de problèmes.

Ensuite, pour lier mon email, j’ai entré la commande git config --global user.email "your_email_address" avec mon adresse mail entre guillemets.

Pour vérifier si tout est en ordre, j’ai tapé git config --global --list. Normalement, votre nom d’utilisateur et votre email entrés précédemment doivent s’afficher.

Créer une clé SSH#

Après m’être correctement identifié, j’ai créé une clé SSH en entrant la commande ssh-keygen -t ed25519. La commande se termine par le type de clé SSH que vous voulez générer. Dans mon cas, j’ai choisi la clé ED25519 car c’est celle la plus recommandée. Après cela, un message m’a demandé d’entrer un passphrase deux fois d’affilé. Ensuite ceci s’est affiché :

Cela signifie que la clé a bien été générée.

Ajouter la clé SSH à son compte Gitlab#

Normalement, une clé publique et une clé privée ont été créées dans le répertoire ~/.ssh. J’ai copié le contenu de la clé publique (le fichier se terminant par “.pub”) puis je suis allé sur mon compte Gitlab, j’ai cliqué sur ma photo de profil > modifier profil > clé SSH > ajouter une nouvelle clé, puis j’ai collé le contenu de ma clé publique.

Vérifier que la clé a bien été synchronisé#

Pour voir si la clé a correctement été synchronisé à mon compte Gitlab, j’ai entré la commande ssh -T git@gitlab.com et ceci est apparu :

S’il y a une erreur, vérifiez que vous avez entré les bonnes données de votre compte Gitlab (voir “Lier son compte Gitlab”).

Cloner son projet#

Pour se faire, j’ai d’abord navigué à travers les emplacements de mon pc à l’aide des commandes Unix afin de trouver un endroit adéquat pour cloner mon projet. Après, je suis allé sur Gitlab et j’ai cliqué sur mon projet > cloner > cloner avec SSH > copier.

Ensuite, j’ai entré la commande git clone suivi de l’URL copié.

J’ai confirmé en tapant yes puis le dossier comprenant l’ensemble du projet a été copié à l’emplacement où je me situais dans la boite de commande.

Modifier son projet#

Pour pouvoir modifier mon index, j’ai ouvert le fichier index.md avec un éditeur de texte (j’ai pris Visual Studio Code). Une fois la modification faite, je suis allé dans la boite de commande Git et j’ai entré git status pour vérifier qu’il y a bel et bien eu un changement dans mes fichiers. Ensuite, j’ai tapé git add -A pour ajouter tous les changements puis git commit -m "commentaire" avec la raison du changement entre guillemets (le commentaire s’affichera dans votre espace Gitlab du coup n’écrivez pas n’importe quoi) pour confirmer les changements. Enfin, j’ai entré git push pour mettre à jour les changements sur Gitlab.

Petites astuces utiles#

Voir un aperçu de la mise en page du texte#

Marre de toujours devoir entrer toutes ces commandes justes pour voir un aperçu du résultat ? Si vous utilisez VScodium ou Visual Studio Code comme moi, j’ai la solution ! Tout d’abord, ouvrez le fichier que vous voulez modifier avec votre éditeur de texte. Ensuite, faites un clique droit sur le nom de votre fichier puis sélectionnez “Open Preview” (vous pouvez aussi faire Ctrl+Shift+V).

Un onglet avec un aperçu de votre fichier s’affichera alors. Vous pouvez ensuite scinder en 2 et mettre votre fichier d’un côté et l’aperçu de l’autre pour pouvoir voir les modifications en temps réel.

Réduire la taille d’une image#

Souvent, il m’est arrivé que certaines images soient trop grandes par rapport au reste du texte. Il m’a donc fallu que je réduise leurs tailles ainsi que leurs nombres de pixels par la même occasion (ça permet aussi d’économiser de l’espace de stockage). Pour se faire, j’ai installé GIMP, puis avec ce logiciel, j’ai ouvert une des images qui étaient trop grandes. En haut à gauche, sur la barre horizontal, j’ai cliqué sur Image > Echelle et taille de l’image ensuite j’ai modifié le nombre de pixels en maintenant les bonnes proportions. Pour maintenir les bonnes proportions, il faut cliquer sur la petite chaine qui relie la hauteur et la largeur (voir dernière image ci-dessous).