Support

h1. Redmine pour les utilisateurs

h2. 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$.

h2. Bonnes pratiques pour la rédaction du wiki

{TODO}

h2. Bonnes pratiques pour la gestion des tickets

Le gestionnaire de tickets permettent la formalisation de travaux de nature variée : tâches, demandes, actions, évolution, compte rendu...  Ces différents travaux ont les points communs suivants :

* ils sont localisés dans le temps avec une date de début et souvent une date d'échéance ;

* ils sont localisés dans l'équipe projet dans la mesure où un ticket ne peut être assigné qu'à une seule personne (avec éventuellement des observateurs qui seront notifiés de son évolution) ;

* ils contiennent un état qui témoigne de leur cycle de vie (nouveau, en cours, résolu...) ainsi qu'un indicateur de complétion.

En fonction de la nature des travaux (trackers), les tickets peuvent faire apparaître différents champs supplémentaires qui permettent de structurer au mieux l'information. Par exemple, un compte rendu de réunion fera apparaître les noms des personnes présentes alors qu'un rapport d'anomalie ne comportera pas un tel champ. Un tel formatage imposé permet ensuite de retrouver facilement les tickets dans un projet donné.

Le gestionnaire de ticket permet de suivre le déroulement des travaux, en conservant l'historique et la traçabilité des modifications, en établissant des relations entre les différents tickets, en assurant la notification par courriel des utilisateurs concernés.

L'objectif des tickets est de faciliter le partage des informations liées à la gestion du projet entre les membres de l'équipe. Cela nécessite toutefois le respect de certaines règles et bonnes pratiques...

* Tous les champs d'un tickets doivent être remplis le plus précisément possible.

* Les tickets doivent traiter de travaux élémentaires, c'est à dire dont la durée doit être la plus courte possible.

* Durant leur cycle de vie, les tickets doivent évoluer pour refléter la réalité du travail accompli (complétion, assignation...).

* Les tickets peuvent faire référence à d'autres objets de l'espace de travail collaboratif (ex. : pages de wiki, documents, fichiers, annonces, gestionnaire de code source...), il faut favoriser la navigation hypertexte. Au besoin, consulter l'aide en ligne de l'éditeur afin de réaliser ces liens.

h2. Utilisation des dépôts de code source

h3. Adresses des dépôts

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

<pre>

https://redmine.gipsa-lab.grenoble-inp.fr/<type>/<nom-depot>

</pre>

où

* @<type>@ est à remplacer par @svn@ ou @git@ en fonction du dépôt créé ;

* @<nom-depot>@ est à remplacer par l'identifiant donné au dépôt.

Ces deux éléments doivent être fournis par le créateur du dépôt ; il est recommandé de les faire figurer dans le wiki du projet.

h3. Utilisation de SVN

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. Utilisation de Git

Plusieurs bons tutoriel tels que "celui-ci":https://fr.atlassian.com/git/tutorials/setting-up-a-repository ou "celui-là":http://backlogtool.com/git-guide/en/intro/intro1_1.html permettent de prendre en main Git rapidement. Cela dit, l'outil reste beaucoup plus puissant et beaucoup plus difficile à manier que SVN. Ne pas hésiter à se référer à sa "documentation officielle":http://git-scm.com/doc en cas de besoin. Pour un perçu des principales commandes, on peut aussi imprimer cette "refcard":https://training.github.com/kit/downloads/github-git-cheat-sheet.pdf.

h2. Goodies

h3. Les notifications par courriel et par flux Atom

{TODO}

h3. 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...

# Sélectionner une photo d'identité ou se créer un avatar, par exemple en utilisant http://www.faceyourmanga.com.

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