Support

h1. Documentation de la forge Redmine du GIPSA-lab

{{>toc}}

La plate-forme Redmine du GIPSA-lab est une _forge_ ; elle offre différents outils (wikis, forums, gestionnaires de tickets, gestionnaires de révisions) pour faciliter le *travail collaboratif* autour de *projets de recherche* comportant généralement du code source (ex. : rédaction d'articles scientifiques, projets de recherche, projets de développement...). Le système est accessible aux *utilisateurs membres du GIPSA-lab* ainsi qu'aux *utilisateurs externes* (sur demande).

Cette documentation technique comporte deux principales parties. La première est à destination de l'ensemble des utilisateurs ; la seconde concerne plus particulièrement les responsables de projets.

h2. Redmine pour les utilisateurs

h3. Mise en forme du texte

Redmine utilise le langage _Textile_ pour mettre en forme le texte dans la plupart des zones de saisie. Ce langage faiblement typé est relativement intuitif, mais certaines de ses fonctionnalités avancées sont décrites ci-dessous.

* La documentation officielle du langage Textile utilisé dans Redmine est disponible ici : http://www.redmine.org/projects/redmine/wiki/RedmineTextFormatting.

* Le plugin Wiking permet d'étendre les possibilités du langage, tel que décrit ici : http://projects.andriylesyuk.com/projects/wiking/wiki/Syntax.

* Le plugin MathJax permet d'écrire des expressions mathématiques avec la syntaxe LaTeX : par exemple @$\sum_i x_i$@ donne $\sum_i x_i$.

h3. Utilisation des dépôts de code source SVN

Lorsqu'un projet dispose d'un dépôt de code source SVN, son adresse est sous la forme :

<pre>

https://svn.gipsa-lab.grenoble-inp.fr/reposit/nom-projet

</pre>

où @nom-projet@ doit être remplacé par le nom court du projet Redmine.

Pour apprendre à utiliser SVN, il est recommandé de lire "cette page":https://ensiwiki.ensimag.fr/index.php/Subversion. Les principales commandes sont synthétisées dans une "refcard":http://www.digilife.be/quickreferences/QRC/Subversion%20Quick%20Reference%20Card.pdf.

h3. Goodies

*Les avatars*

Il est possible d'utiliser un avatar sous Redmine, mais à première vue ce n'est pas dans la rubrique _Mon compte_ que cela se passe. En fait, la plate-forme n'héberge pas les avatars des utilisateurs, ces derniers sont téléchargés à la volée à partir de Gravatar. Voici comment procéder...

# Se créer un avatar, par exemple en utilisant http://www.faceyourmanga.com conjointement avec une habile capture d'écran.

# Se créer un compte sur https://en.gravatar.com en mentionnant l'adresse e-mail utilisée sous Redmine, puis charger l'avatar créé précédemment.

h2. Redmine pour les responsables de projets

h3. Création d'un nouveau projet Redmine

La création d'un nouveau projet s'effectue sur demande au service informatique du GIPSA-lab, à l'adresse sos-info@gipsa-lab.grenoble-inp.fr. Il est nécessaire de fournir les éléments suivants :

* nom du projet (préférer les noms courts) ;

* nom du responsable du projet (doit être membre du GIPSA-lab).

Une fois le projet créé, son responsable a la possibilité d'ajouter des sous-projets.

h3. Création et administration d'un dépôt de code source SVN

Un dépôt de code source SVN peut être associé à chaque projet Redmine, il permet la gestion collaborative du code source. Sa création est optionnelle et est réalisée manuellement par le service informatique (via sos-info@gipsa-lab.grenoble-inp.fr). Le dépôt de code source SVN peut être initialisé dans deux cas de figure :

* en même temps qu'un projet Redmine ;

* n'importe quand, pour un projet Redmine existant.

La gestion des permissions relatives au dépôt sont ensuite gérée par le responsable du projet, via l'interface intranet...

{TODO} Cette partie est à compléter par Christian ou Anne.

h3. Création d'un compte d'utilisateur externe

La création d'un compte d'utilisateur externe s'effectue sur demande adressée au service informatique du GIPSA-lab, à l'adresse sos-info@gipsa-lab.grenoble-inp.fr. Les renseignements suivants doivent être fournis :

* nom ;

* prénom ;

* fonction ;

* affiliation ;

* adresse e-mail.

h3. Utilisation parcimonieuse des modules Redmine

Pour chaque projet, la plate-forme collaborative Redmine offre une grande variété de modules (wikis, forums, visualiseur de dépôts de code source, gestionnaire de tickets, annonces...). Un trop grand nombre de fonctionnalités peut être rapidement déroutant pour les utilisateurs. Par conséquent, il du ressort des gestionnaires de projets de limiter ces dernières (onglet @Configuration@) en fonction des méthodes de développement envisagées (ex. : inutile d'afficher l'explorateur de code source si aucun dépôt n'a été initialisé, limiter le nombre de trackers des tickets...).