Wiki

Dépôt simple de documents

Pour centraliser vos documents, nous utilisons l’outil Gitlab. Celui-ci peut être déroutant au premier abord, car l’interface est très fournit.

Pas de panique ! Nous n’utiliserons en réalité qu’une toute petite partie de ses fonctionnalités. Ne vous préoccupez pas des divers onglets disponibles. En suivant les tutoriels, vous devriez vous en sortir facilement.

Tout d’abord il faut vous enregistrer ici : https://gricad-gitlab.univ-grenoble-alpes.fr/cop2-etudiante1 Si vous êtes étudiants à l’Université Grenoble Alpes, vous êtes déjà inscrits et pouvez utiliser vos identifiants usuels.

Une fois que vous êtes inscrit, il vous faut demander à votre RR de vous ajouter au dépôt de votre établissement. Tant qu’il ne vous aura pas ajouté, vous ne pourrez pas acceder du tout au Gitlab, ce qui est complètement normal.

Une fois que vous avez accès à votre dépot, vous pouvez :

Note: ne pas mettre d’espaces dans les noms de fichier ! Utilisez plutôt un tiret bas comme_ceci.

Ci dessous vous est expliqué plus en détail ce qu’est GITLAB, son interêt, etc ! A approfondir pour les curieux !

Introduction

Ce wiki est principalement destiné aux membres des groupes de travail amenés à travailler avec la COP2 Étudiante. Il décrit l’architecture mise en place, et présente les outils utilisés.

Ce wiki a été écrit pour des gens pas ou peu familiers avec les outils utilisés (git, gitlab, pandoc…), et reste donc assez peu technique sur leur fonctionnement. De nombreuses ressources sont disponibles en ligne pour les personnes qui souhaiteraient aller plus loin avec ces outils.

En cas de problèmes, vous pouvez envoyer un mail à remy.le-calloch@grenoble-inp.org.

Architecture et Workflow

Markdown

Markdown est un langage de balisage très simple. Il permet d’éditer des fichiers textes sans logiciel de mise en forme (Libre Office, Word…). Si vous utilisez Discord, vous connaissez déjà Markdown sans le savoir !

Ce langage possède plusieurs avantages:

Si un fichiers est écrit en Markdown, il est très facile ensuite de le convertir en un autre format ! L’outil que nous utilisons pour cela est Pandoc.

Syntaxe Markdown

La syntaxe Markdown est très simple. De nombreuses fiches mémoires sont disponibles sur internet, par exemple celle-ci.

Un rappel de la syntaxe est également parfois présent dans les logiciels de traitement de texte dédiés.

Vous pouvez également consulter des exemples de documents rédigés en Markdown un peu plus bas.

Rédiger en markdown

Il est possible de rédiger du Markdown depuis n’importe quel éditeur de texte ! Néanmoins, de nombreuses solutions existes pour simplifier la rédaction, notamment en proposant une prévisualisation du contenu. Voici quelques possibilités:

En ligne

Windows & Linux

Mac

Exemples

Un exemple sous vos yeux depuis le début: le code qui a permis de générer cette page

avec celui-ci, on peut générer…

… cette page web … ou alors un pdf … voir même un diaporama !

La plateforme

Afin de stocker et d’échanger des ressources, nous utilisons des dépôts gitlab. Les pages que vous consultez sont générées automatiquement depuis ces dépôts, à partir des fichiers ajoutés par les groupes de travail.

Ce fonctionnement vise à proposer une alternative à des solutions plus lourdes comme Google Drive. Pour en savoir plus, faire des retours ou apporter votre aide, vous pouvez envoyer un mail à remy.le-calloch@grenoble-inp.org.

Nous ne rentrons pas pour le moment dans le détail de cet outil, celui-ci n’étant pas encore arrivé à maturité. À terme, le souhait de l’équipe est de former les responsables des groupes de travail à son utilisation. En effet, celui-ci a plusieurs avantages:

Le site

Les ressources mises à disposition sont disponibles sur le site que vous consultez actuellement. C’est également sur ce site que seront publiés les synthèses du travail des différents groupes.