Guide Utilisateur Codendi 4.0

1. Guide de l'utilisateur Codendi "Dveloppement logiciel et gestion de projets collaboratifs pour l'entreprise" www.codendi.org Version 3.6

2. Copyright 2000-2008 Xerox Corporation, Codendi. Ce document est diffus sous la licence GNU General Public version 2. Copyright protection claimed includes all forms and matters of copyrightable material and information now allowed by statutory or ju- dicial law or hereinafter granted, including without limitation, material generated from the software programs which are displayed on the screen such as icons, screen displays, looks, etc. Xerox et tous les produits Xerox mentionns dans cette publication sont des marques dposes de Xerox Corporation. Ce document a t format l'aide de la DTD XML DocBook. La version HTML a t gnre avec le gnerateur HTML de Doc- Book. La version PDF a t faite l'aide de Apache FOP.

3. Table des matires 1.Introduction.......................................................................................................................1 2. Vue d'ensemble du site Codendi .................................................................................... 4 2.1. PAGE D'ACCUEIL CODENDI ......................................................................................... 4 2.2. LE MENU PRINCIPAL DE CODENDI ............................................................................... 4 2.2.1. Arbre des projets ........................................................................................... 6 2.2.2. La bote outils ............................................................................................. 7 2.2.3.Aide...............................................................................................................10 2.2.4. La fonction de recherche .............................................................................. 11 2.3. LE TABLEAU DE BORD DE CODENDI ............................................................................. 11 3. Devenir un utilisateur Codendi ........................................................................................ 13 3.1. LES CLASSES D'UTILISATEURS .................................................................................... 13 3.2. ENREGISTREMENT DES UTILISATEURS ......................................................................... 14 3.3. CONNEXION ET PAGE PERSONNELLE ........................................................................... 15 3.4. GESTION DE COMPTE ................................................................................................. 16 3.5.PRFRENCES ...........................................................................................................17 4. Crer un nouveau projet .................................................................................................. 18 4.1. ENREGISTRER UN PROJET .......................................................................................... 18 4.2. CONFIGURATION POST-ENREGISTREMENT ................................................................... 20 5. Sommaire du projet .......................................................................................................... 21 5.1. ACCDER AU SOMMAIRE DU PROJET .......................................................................... 21 5.2. CONTENU DE LA PAGE DE SOMMAIRE .......................................................................... 22 6. Administration d'un projet ............................................................................................... 25 6.1. MENU D'ADMINISTRATION DU PROJET .......................................................................... 25 6.2. AJOUT/SUPPRESSION D'UTILISATEURS ........................................................................ 25 6.2.1. Ajout d'un utilisateur ...................................................................................... 25 6.2.2. Import d'une liste d'utilisateurs ...................................................................... 25 6.2.3. Suppression d'utilisateurs ............................................................................. 26 6.3. INFORMATIONS PUBLIQUES DU PROJET ........................................................................ 27 6.4. CATGORISATION DU PROJET ..................................................................................... 27 6.5. TYPE DE PROJET ........................................................................................................ 27 6.6. CONFIGURATION DES SERVICES .................................................................................. 28 6.6.1. Crer ou modifier un service ......................................................................... 29 6.6.2. Suppression d'un service .............................................................................. 30 6.7. ADMINISTRATION DES SERVICES ................................................................................. 30 6.8. CONFIGURATION DES PATRONS DE RFRENCE ........................................................... 30 6.8.1. Prsentation des rfrences ......................................................................... 30 6.8.2. Patrons de rfrence prdfinis .................................................................... 31 6.8.3. Utilisation des rfrences .............................................................................. 32 6.8.4. Cration ou modification d'un patron de rfrence ....................................... 32 6.8.5. Suppression d'un patron de rfrence .......................................................... 34 6.9. PERMISSIONS UTILISATEURS ....................................................................................... 34 6.10. GROUPES D'UTILISATEURS ........................................................................................ 35 6.10.1. Gestion des groupes d'utilisateurs .............................................................. 35 6.10.2. Crer un groupe d'utilisateurs ..................................................................... 36 6.10.3. Modifier un groupe d'utilisateurs ................................................................. 38 6.10.4. Supprimer un groupe d'utilisateurs ............................................................. 38

4. 6.10.5. Informations complmentaires sur les groupes d'utilisateurs ..................... 38 6.11. EXPORTATION DES DONNES DU PROJET .................................................................. 39 6.11.1. Donnes exportes ..................................................................................... 39 6.11.2. Exportation au format texte ......................................................................... 39 6.11.3. Accs direct la base de donnes ............................................................. 40 6.12. IMPORTATION D'ARTEFACTS DANS LES OUTILS DE SUIVI ............................................. 42 6.13. HISTORIQUE DU PROJET ........................................................................................... 42 6.14. JOURNAL DES ACCS ............................................................................................... 42 7. Service outils de suivi ...................................................................................................... 44 7.1. TERMINOLOGIE ET POINTS COMMUN ............................................................................ 44 7.2. ACCDER UN OUTIL DE SUIVI ................................................................................... 44 7.3. SOUMISSION D'UN NOUVEL ARTEFACT ......................................................................... 45 7.4. NAVIGUER DANS LES ARTEFACTS ................................................................................ 47 7.4.1. Critre de slection ....................................................................................... 47 7.4.2. Requtes favorites ou prdfinies pour les outils de suivi ............................ 49 7.4.3. Rsultats de la recherche dans un outil de suivi ........................................... 50 7.5. MODIFIER UN ARTEFACT ............................................................................................. 52 7.5.1.Entte............................................................................................................52 7.5.2.Commentaires...............................................................................................53 7.5.3. Destinataires en copie .................................................................................. 55 7.5.4. Fichiers attachs un artefact ...................................................................... 56 7.5.5. Dpendances entre artefact .......................................................................... 56 7.5.6. Rfrences croises entre artefact ............................................................... 57 7.5.7. Permissions sur les artefacts ........................................................................ 57 7.5.8. Historique des artefacts ................................................................................ 58 7.6. MISE JOUR MASSIVE D'ARTEFACTS ........................................................................... 58 7.6.1. Critres de slection ..................................................................................... 59 7.6.2. Mise jour .................................................................................................... 59 7.7. DUPLIQUER UN ARTEFACT .......................................................................................... 61 7.8. NOTIFICATION EMAIL .................................................................................................. 61 7.9. IMPORTATION D'ARTEFACTS ........................................................................................ 61 7.9.1. Quand utiliser la fonction d'importation ? ...................................................... 62 7.9.2. Exporter une feuille de calcul Excel au format CSV ..................................... 62 7.9.3. Analyse du fichier CSV ................................................................................. 62 7.9.4. Mise jour de la base de donnes ............................................................... 63 7.10. PERMISSIONS D'ACCS PAR DFAUT AUX OUTILS DE SUIVI ......................................... 64 7.11. CRATION D'UN OUTIL DE SUIVI ................................................................................. 65 7.12. PATRONS D'OUTILS DE SUIVI DU SITE ........................................................................ 66 7.12.1. L'outil de suivi d'anomalies (bugs) .............................................................. 67 7.12.2. L'outil de suivi de correctifs (patches) ......................................................... 67 7.12.3. L'outil de suivi de demandes d'assistance (support requests) .................... 67 7.12.4. L'outil de suivi de tches ............................................................................. 68 7.12.5. L'outil de suivi des besoins de la mthodologie Scrum (Scrum Backlog) ................................................................................................................................. 8 6 7.13. ADMINISTRATION DES OUTILS DE SUIVI ...................................................................... 69 7.13.1. Options gnrales ....................................................................................... 70 7.13.2. Gestion des permissions ............................................................................. 70 7.13.3. Gestion des groupes de champs ................................................................ 73 7.13.4. Gestion de l'utilisation des champs ............................................................. 75 7.13.5. Gestion des valeurs des champs ................................................................ 79 7.13.6. Dpendances entre champs ....................................................................... 83 7.13.7.Rponses-type............................................................................................89 7.13.8. Gestion des rapports de recherche ............................................................. 89

5. 7.13.9. Configuration des rapports graphiques de recherche ................................. 92 7.13.10. Options de notification email ..................................................................... 94 8. Publication de fichiers ..................................................................................................... 98 8.1. PUBLICATION DU CODE SOURCE : CONSEILS ................................................................ 98 8.2. JARGON DU SERVICE DE PUBLICATION DE FICHIERS ..................................................... 98 8.3. NAVIGATION DANS LES FICHIERS PUBLIS ET TLCHARGEMENT .................................. 100 8.3.1. Navigation dans les paquets ......................................................................... 100 8.3.2. Navigation dans les versions ........................................................................ 101 8.3.3. Tlchargement de fichiers ........................................................................... 101 8.4. ADMINISTRATION ET LIVRAISON DE FICHIERS ............................................................... 101 8.4.1. Administration des paquets ........................................................................... 102 8.4.2. Administration des versions .......................................................................... 103 8.5. ADMINISTRATION DE LA LISTE DES PROCESSEURS ....................................................... 106 9. Contrle de version avec CVS ......................................................................................... 107 9.1. CVS : CONCURRENT VERSION CONTROL ................................................................... 107 9.1.1. Clients CVS ................................................................................................... 108 9.1.2. Rfrences CVS ........................................................................................... 109 9.2. INTGRATION DE CVS DANS CODENDI ........................................................................ 110 9.2.1. Le dpt CVS ................................................................................................ 110 9.2.2. Contrle d'accs CVS ................................................................................... 110 9.3. L'INTERFACE DE NAVIGATION WEB DE CVS ................................................................ 111 9.3.1. Naviguer dans le dpt CVS ......................................................................... 111 9.3.2. Interroger le dpt CVS ................................................................................ 112 9.3.3. Rfrences croises entre artefacts et commits CVS .................................. 114 9.3.4. Administration CVS ....................................................................................... 115 9.4. UN CYCLE DE VIE TYPIQUE DE CVS ............................................................................ 116 9.4.1. Se connecter ................................................................................................. 117 9.4.2. Importer du code source existant .................................................................. 118 9.4.3. Crer une copie de travail (checkout) ........................................................... 118 9.4.4. Mettre jour le code source (update) ........................................................... 119 9.4.5. Remonter les modifications vers le dpt (commit) ...................................... 119 9.4.6. Proposer des modifications l'quipe de projet ........................................... 120 9.4.7. Exporter et empaqueter ................................................................................ 121 9.5. CVS POUR LES ADMINISTRATEURS DE PROJET ............................................................ 122 9.5.1. Plus d'information sur le contrle d'accs CVS ......................................... 122 9.5.2. Les fichiers d'administration de CVS ............................................................ 123 10. Contrle de version avec Subversion .......................................................................... 124 10.1. SUBVERSION : L'APRS CVS .................................................................................... 124 10.1.1. Les clients Subversion ................................................................................ 126 10.1.2. Rfrences Subversion ............................................................................... 127 10.2. INTGRATION DE SUBVERSION DANS CODENDI .......................................................... 127 10.2.1. Le dpt Subversion ................................................................................... 127 10.2.2. La structure du dpt Subversion ............................................................... 128 10.3. L'INTERFACE DE NAVIGATION WEB DE SUBVERSION ................................................... 128 10.3.1. Naviguer dans le dpt Subversion ............................................................ 129 10.3.2. Interroger le dpt Subversion .................................................................... 130 10.3.3. Rfrences croises entre artefacts et commits Subversion ...................... 131 10.4. INTERFACE D'ADMINISTRATION DE SUBVERSION ......................................................... 132 10.4.1. Options gnrales ....................................................................................... 132 10.4.2. Contrle des accs au dpt Subversion ................................................... 133 10.4.3. Notification e-mail de Subversion ............................................................... 135 10.5. UN CYCLE DE VIE TYPIQUE DE SUBVERSION .............................................................. 136

6. 10.5.1. Se connecter ............................................................................................... 136 10.5.2. Importer du code source existant ................................................................ 137 10.5.3. Crer une copie de travail (checkout) ......................................................... 137 10.5.4. Mettre jour le code source (update) ......................................................... 138 10.5.5. Observer les modifications .......................................................................... 138 10.5.6. Remonter les modifications vers le dpt (commit) .................................... 139 10.5.7. Proposer des modifications l'quipe de projet ......................................... 140 10.5.8. Exporter et empaqueter .............................................................................. 141 10.6. SUBVERSION POUR LES ADMINISTRATEURS DE PROJET .............................................. 141 10.6.1. Les scripts d'accrochage de Subversion (hook scripts) .............................. 141 11. Gestionnaire de Documents .......................................................................................... 143 11.1.STRUCTURE .............................................................................................................143 11.2.ACTIONS ..................................................................................................................144 11.2.1. Nouveau Document .................................................................................... 144 11.2.2. Nouveau Dossier ........................................................................................ 146 11.2.3.Proprits....................................................................................................147 11.2.4.Notifications................................................................................................148 11.2.5.Historique....................................................................................................148 11.2.6. Mise jour .................................................................................................. 149 11.2.7. Nouvelle version ......................................................................................... 149 11.2.8.Permissions................................................................................................150 11.2.9.Dplacer......................................................................................................151 11.2.10.Delete........................................................................................................152 11.3.ADMINISTRATION ......................................................................................................152 11.3.1.Permissions................................................................................................152 11.3.2. Afficher les permissions .............................................................................. 153 11.3.3.Proprits....................................................................................................153 12. Gestionnaire de Tests .................................................................................................... 154 12.1. PRSENTATION DE SALOME ...................................................................................... 154 12.2. CONFIGURATION ET ADMINISTRATION ....................................................................... 154 12.2.1. Outil de suivi Salome .................................................................................. 154 12.2.2.Permissions................................................................................................156 12.2.3. Plugins Salome ........................................................................................... 157 12.2.4. Prfrences Salome ................................................................................... 158 12.3. LANCER SALOMETMF .............................................................................................. 159 13. Intgration Continue avec Hudson ............................................................................... 160 13.1. INTRODUCTION L'INTGRATION CONTINUE ............................................................... 160 13.2. INSTALLATION DE HUDSON ....................................................................................... 161 13.3. CONFIGURATION DE HUDSON ................................................................................... 162 13.3.1. Configuration systme ................................................................................ 162 13.3.2. Plugins Hudson ........................................................................................... 164 13.4. CRATION ET CONFIGURATION DE JOBS HUDSON ...................................................... 164 13.4.1. CVS et Subversion ...................................................................................... 164 13.4.2. Dclenchement des builds .......................................................................... 165 13.4.3. Dfinition du build (Etapes) ......................................................................... 165 13.4.4. Actions la suite du build ........................................................................... 166 13.5. INTGRATION DANS CODENDI ................................................................................... 167 13.5.1. Service Hudson ........................................................................................... 167 13.5.2. Widgets Hudson .......................................................................................... 168 13.5.3. Rfrences Hudson .................................................................................... 172 14. Service Wiki .................................................................................................................... 174

7. 14.1. PRSENTATION D'UN WIKI ........................................................................................ 174 14.1.1. Dfinition d'un Wiki ...................................................................................... 174 14.1.2. Wiki Page Formatting .................................................................................. 174 14.1.3. Lier et crer des pages ............................................................................... 174 14.1.4.Rechercher.................................................................................................175 14.2. LES WIKIS DE CODENDI ........................................................................................... 175 14.2.1. Cration d'un Wiki ....................................................................................... 175 14.2.2. Permissions du Wiki .................................................................................... 175 14.2.3. Exemples de pages Wiki ............................................................................. 176 14.2.4. En savoir plus ............................................................................................. 176 15. Services de communication .......................................................................................... 177 15.1. LISTES DE DISTRIBUTION .......................................................................................... 177 15.1.1.Cration......................................................................................................177 15.1.2.Administration.............................................................................................178 15.1.3. (Ds)Inscription, archive et prfrences ..................................................... 178 15.2. SERVICE D'ANNONCES .............................................................................................. 178 15.3. FORUMS WEB .......................................................................................................... 179 15.4. PLUG-IN DE MESSAGERIE INSTANTANE .................................................................... 179 15.4.1. Intgration de la messagerie instantane dans Codendi ............................ 180 15.4.2. Configuration d'un client Jabber .................................................................. 180 15.4.3. Salon de discussion multi-utilisateurs (MUC) ............................................. 181 15.4.4. Archives des conversations ........................................................................ 184 16. Gestionnaire de sondages ............................................................................................. 186 16.1. PUBLIER UN SONDAGE .............................................................................................. 187 16.2. ADMINISTRATION DES SONDAGES .............................................................................. 188 16.2.1. Structure d'un sondage ............................................................................... 189 16.2.2. Crer et diter des questions ...................................................................... 189 16.2.3. Crer ou modifier un sondage .................................................................... 190 16.2.4. Consulter les rsultats d'un sondage .......................................................... 191 17. Site Web d'un projet ....................................................................................................... 193 17.1. VISITER UN SITE WEB .............................................................................................. 193 17.2. CRATION D'UN SITE WEB ........................................................................................ 193 17.2.1. Emplacement et structure des rpertoires .................................................. 193 17.2.2. Utilisez PHP pour votre site Web ................................................................ 194 17.2.3. Publication du site Web .............................................................................. 194 17.3. RFRENCER LE SITE CODENDI ................................................................................ 196 18. Autres Services ............................................................................................................... 197 18.1. COMPTE SHELL ....................................................................................................... 197 18.2. ESPACES DE STOCKAGE FTP ANONYME ................................................................... 197 18.3. API SOAP .............................................................................................................. 198 18.4. CLIENT EN LIGNE DE COMMANDE CODENDI (COMMAND LINE INTERFACE, CLI) ........... 198 18.5. PLUGIN ECLIPSE CODENDI ....................................................................................... 198

8. Liste des illustrations 1. La page d'accueil de Codendi ............................................................................................ 2 2. La page d'accueil de Codendi avec un thme diffrent (avec des onglets) ....................... 3 3. Vue d'ensemble du site Codendi ........................................................................................ 5 4. Exemple de navigation dans l'arbre des projets ................................................................. 6 5. Liste des chantillons de code dans la catgorie 'HTML Manipulation' .............................. 8 6. La page personnelle d'un utilisateur Codendi ..................................................................... 15 7. Un exemple de page de Sommaire d'un projet .................................................................. 23 8. Un exemple de page d'administration d'un projet ............................................................... 27 9. Un exemple de table de permissions des membres d'un projet ......................................... 34 10. Page de gestion des groupes d'utilisateurs ...................................................................... 36 11. dition d'un groupe d'utilisateur ........................................................................................ 37 12. Exemple de journal d'accs .............................................................................................. 43 13. Page d'accueil de l'outil de suivi ....................................................................................... 45 14. Un exemple d'cran de soumission d'artefact (ici de type "bug") ..................................... 46 15. Un exemple d'affichage des rsultats d'une requte sur un tracker ................................. 50 16. Entte d'un cran de modification d'un artefact (champs de l'outil de suivi) .................... 53 17. Commentaires attachs un artefact ............................................................................... 54 18. Dpendance entre artefacts ............................................................................................. 56 19. Permissions d'un artefact ................................................................................................. 58 20. Historique d'un artefact ..................................................................................................... 58 21. cran de slection des artefacts pour une mise jour massive ....................................... 59 22. Section d'entte de l'cran de mise jour massive d'artefacts ........................................ 60 23. Section destinataire en copie de l'cran de mise jour massive d'artefacts .................... 60 24. Cration d'un nouvel outil de suivi (ici pour des anomalies) ............................................. 66 25. Administration des outils de suivi - Page d'accueil ........................................................... 69 26. Exemple d'cran de permissions pour un outil de suivi .................................................... 71 27. cran de gestion des groupes de champs dans un outil de suivi ..................................... 74 28. cran de gestion de l'utilisation des champs dans un outil de suivi ................................. 77 29. Configuration des champs utiliss dans un outil de suivi ................................................. 79 30. Liste des champs dont les valeurs sont dfinies par l'utilisateur ...................................... 80 31. Liste des valeurs du champ "Resolution" ......................................................................... 81 32. Configuration des valeurs d'un champ ............................................................................. 82 33. Dpendances pour le systme Linux ................................................................................ 83 34. Dpendances pour le systme MacOS X ......................................................................... 84 35. Dpendances pour le systme MS Windows ................................................................... 85 36. Dpendances pour le systme NetBSD ........................................................................... 86 37. La version 2.0 "dpend" de Linux et NetBSD ................................................................... 87 38. Les versions proposes pour Linux .................................................................................. 87 39. Les versions proposes pour MacOS X ........................................................................... 88 40. Les versions proposes pour MS Windows ...................................................................... 88 41. Les versions proposes pour NetBSD .............................................................................. 88 42. Dfinition d'une rponse-type ........................................................................................... 89 43. Exemple d'une liste de rapports de recherche ................................................................. 90 44. Configuration d'un rapport de recherche .......................................................................... 92 45. Configuration de la matrice de notification personnelle .................................................... 97 46. Structure du service de publication de fichiers ................................................................. 99 47. L'cran de publication des fichiers du projet Codendi Administration Project .................. 100 48. L'cran du service Fichier du projet "Codendi Administration project", si vous tes administrateur.............................................................................................................................102 49. Ecran de modification du paquet CLI du projet "Codendi Administration" ........................ 103

9. 50. Ecran de modification d'une version du projet Codendi ................................................... 104 51. Un exemple de navigation dans le dpt CVS ................................................................. 112 52. Interrogation de la base de suivi CVS d'un projet ............................................................. 113 53. Dtails concernant une opration de commit CVS ........................................................... 114 54. Un cycle de dveloppement logiciel typique sur Codendi ................................................ 117 55. Un exemple de navigation dans le dpt Subversion ....................................................... 129 56. Interrogation de la base de suivi Subversion d'un projet .................................................. 131 57. Dtails concernant une opration de commit Subversion ................................................ 132 58. Un cycle de dveloppement logiciel typique sur Codendi ................................................ 136 59. Dossiers et sous-dossiers ................................................................................................. 143 60.Actions..............................................................................................................................144 61. Crer un nouveau document ............................................................................................ 145 62. Crer un nouveau dossier ................................................................................................ 147 63. Afficher et editer les proprits ......................................................................................... 148 64.Notifications......................................................................................................................148 65.Historique..........................................................................................................................149 66. Mise jour d'un lien .......................................................................................................... 149 67. Crer une nouvelle version d'un fichier embarqu ........................................................... 150 68. Definir les permissions ...................................................................................................... 150 69. Dplacer un document ...................................................................................................... 152 70. Raccourcis pour dplacer un lment au sein d'un dossier ............................................. 152 71. Configuration de l'outil de suivi Salome ............................................................................ 156 72. Configuration des permissions Salome ............................................................................ 157 73. Configuration des plugins Salome .................................................................................... 158 74. Configuration des prfrences Salome ............................................................................ 159 75. Lancer Salome .................................................................................................................. 159 76. Configuration des outils .................................................................................................... 162 77. Lier un job Hudson votre projet ...................................................................................... 167 78. Visualiser les jobs Hudson associs votre projet ........................................................... 168 79. Widget "Mes jobs Hudson" ............................................................................................... 169 80. Widget "Aperu des jobs" ................................................................................................. 169 81. Widget "Derniers builds" ................................................................................................... 169 82. Widget "Rsultat des tests" .............................................................................................. 170 83. Widget "Tendance des tests" ............................................................................................ 171 84. Widget "Historique des builds" .......................................................................................... 172 85. Widget "Derniers artfacts du build" ................................................................................. 172 86. Salon de discussion dans l'interface web de Codendi ...................................................... 183 87. Page d'accueil du gestionnaire de sondages ................................................................... 186 88. Un exemple de sondage manant du projet Codendi ...................................................... 188 89. cran d'administration du gestionnaire de sondages ....................................................... 189 90. Rsultats d'un sondage .................................................................................................... 192 91. Plugin Codendi pour l'IDE Eclipse .................................................................................... 199

10. Guide de l'utilisateur Codendi CHAPITRE 1 Introduction L'objectif de l'initiative Codendi (initialement Code eXchange) de Xerox est de transposer et d'appliquer les principes du dveloppement Open Source dans notre propre environnement d'entreprise. L'tablissement du dveloppement logiciel et la gestion de projets en mode collaboratif comme l'une des valeurs centrales de notre ingnierie logicielle, amliore la qualit des composants, la productivit des quipes de projet tout en offrant un environnement de travail riche, attractif et efficace. L'initiative Codendi est supporte par un site Web interne disponible sur http://www.codendi.org/. Ce site est ouvert aux quipes de dveloppement de Xerox qui sou- haitent travailler de faon efficace en mode collaboratif. Le Guide de l'utilisateur Codendi dcrit les services et les fonctionnalits de Codendi mais il fournit aussi de nombreux conseils pour vous aider tirer le meilleur parti de Codendi grer vos projets de faon optimale. Nous esprons que vous apprcierez Codendi. N'hsitez pas en parler vos collgues pro- grammeurs, chefs de projets ou responsables de groupe. Gardez aussi prsent l'esprit que ce guide de l'utilisateur est avant tout fait pour vous et que nous serons donc heureux de recevoir toutes vos suggestions de corrections ou d'amliorations. Profitez de Codendi ! L'quipe Codendi 1

11. Guide de l'utilisateur Codendi Figure 1. La page d'accueil de Codendi 2

12. Guide de l'utilisateur Codendi Figure 2. La page d'accueil de Codendi avec un thme diffrent (avec des onglets) 3

13. Guide de l'utilisateur Codendi CHAPITRE 2 Vue d'ensemble du site Codendi Codendi est un site Web de Xerox accessible l'URL http://www.codendi.org/. Pour utiliser le site Codendi vous pouvez utiliser votre navigateur favori1. Codendi est un site riche et ce guide de l'utilisateur va vous accompagner dans la dcouverte de l'ensemble des services disponibles. Pour vous aider retrouver votre chemin dans cette panoplie de services, la Figure 3. Vue d'ensemble du site Codendi [page 5] vous en donne une vue d'ensemble et le chemin em- prunter pour accder un service particulier. 2.1 Page d'accueil Codendi La page d'accueil est divise en quatre parties (voir la Figure 1. La page d'accueil de Codendi [page 2]) : 1. Le menu principal de Codendi : sur la partie gauche de l'cran ou au sommet selon le thme graphique employ. 2. Une courte introduction Codendi : la partie centrale suprieure prsente le site Codendi en quelques points cls et fournit des pointeurs vers des documents ou des services importants. 3. Les dernires nouvelles de Codendi : la partie centrale infrieure montre en perma- nence les dix nouvelles les plus rcentes concernant la vie des projets hbergs ou du site Codendi. 4. La tableau de bord Codendi : La partie droite de la page d'accueil montre une srie d'indicateurs statistiques concernant l'activit globale du site Codendi. 2.2 Le menu principal de Codendi Le menu principal de Codendi est prsent sur l'ensemble des pages du site. Son contenu peut varier selon les pages visites et suivant les droits qui vous sont octroys. En d'autres termes il dpend du contexte. En voici deux exemples : Si vous visitez le site en tant qu'utilisateur anonyme, la partie suprieure du menu vous invite vous connecter au systme ou bien crer un compte si vous n'en avez pas. Si vous tes connect, d'autres entres deviendront visibles dans le menu comme Se d- connecter, Mon compte, Ma page personnelle, etc De la mme faon, si vous dcidez de visiter un projet particulier, le menu situ en haut 1Codendi utilise du HTML standard et trs peu de Javascript. Il est support sur Netscape 6/7, IE 5/6, Mozilla et Firefox. D'autres navigateurs comme Opera ou Konqueror fonctionnent galement. Codendi utilise peu de graphisme et il est donc utilisable par des navigateurs spcialiss comme ceux destins aux personnes malvoyantes. 4

14. Guide de l'utilisateur Codendi de la page vous prsentera l'ensemble des services disponibles. Dans le reste de cette section nous allons uniquement couvrir les entres du menu qui sont per- manentes et indpendantes du contexte. Les autres entres lies aux projets seront dcrites plus tard dans ce document. 5

15. Guide de l'utilisateur Codendi Figure 3. Vue d'ensemble du site Codendi 2.2.1 Arbre des projets L'arbre des projets est un important service de Codendi que vous pouvez (ou devez !) utiliser pour dterminer si certains logiciels dvelopps sur le site peuvent prsenter un intrt pour vos propres activits. L'arbre des projets est l'une des deux faons de chercher des informations dans la base de projets existants. L'autre faon s'appuie sur la fonction Recherche par mots- cls. Figure 4. Exemple de navigation dans l'arbre des projets Quand un projet est cr il est class suivant 7 critres : Statut de dveloppement : le niveau de maturit du projet (alpha, bta, stable,...) Environnement : dans quel environnement tourne le logiciel (Web, Win32, X Window, mode texte,...) Audience : La population d'utilisateurs vise (dveloppeurs, utilisateurs finaux, administrateurs systme,) Licence : la licence de distribution du logiciel. Dans la plupart des cas il s'agira de la licence d'change de Codendi de Xerox Systme d'exploitation : Le ou les systmes d'exploitation sur lesquels le logiciel s'excute Langages de programmation : les langages de programmation utiliss dans le dveloppement de ce projet. Domaine : Le domaine d'application de votre projet qui varie suivant le domaine d'activit de l'entreprise. 6

16. Guide de l'utilisateur Codendi Chaque critre peut recevoir jusqu' trois valeurs pour un projet donn (comme, par exemple, trois langages de programmation). Les valeurs sont choisies parmi une liste prdfinie par les administrateurs du site. Le critre "Domaine" (ou "Topic" en anglais) reflte le domaine dont traite votre projet et se prsente sous la forme d'une hirarchie de domaines et de sous- domaines que l'quipe d'administration de Codendi affine au fur et mesure de l'enregistrement des projets. En utilisant l'arbre des projets il est possible de visualiser les projets rpondants certains critres. Les projets sont prsents avec leurs nom, description, date de cration, taux d'activit et d'autres informations utiles. Les valeurs des sept critres du projet sont affiches la suite de la description. Notez qu' ct de chaque valeur d'un critre figure un lien hypertexte appel [Filtre]. Cliquer sur l'un de ces liens a pour effet de n'afficher que les projets qui correspondent cette valeur du critre. Les projets de type patron et les projets de test (voir Section 6.5 [page 27]) ne sont pas lists dans l'arbre des projets. Un exemple d'affichage de l'arbre des projets est montr Figure 4. Exemple de navigation dans l'arbre des projets [page 6]. Dans cet exemple, l'utilisatrice a d'abord ouvert le dossier Langages de Programmation puis elle a slectionn le langage C. Ceci a probablement amen un grand nombre de projets et elle a donc appliqu deux filtres supplmentaires : le premier spcifie que le Statut de dveloppement doit tre Stable et le second impose que le logiciel fonctionne avec le systme d'exploitation SunOS/Solaris. En appliquant ces multiples critres de slection, l'utilisatrice rduit le nombre de projets poten- tiellement intressants neuf et elle peut donc les examiner un par un (seul le premier projet est montr sur la Figure 4. Exemple de navigation dans l'arbre des projets [page 6]). Les filtres ont une autre proprit intressante : ils sont persistants. Cela signifie que si vous dcidez d'explorer l'arbre des projets en partant d'un autre angle (par exemple en ouvrant le dossier Do- maine en premier), les filtres slectionns continuent s'appliquer. Pour relcher les contraintes imposes par les filtres il suffit de cliquer sur le lien [Supprimer ce filtre] situ ct du critre. Coup de pouce Si vous effectuez souvent le mme parcours dans l'arbre des projets, vous pouvez enregistrer l'tape finale de ce parcours dans votre Page personnelle. Pour se faire, effectuez vos manipulations sur l'arbre comme expliqu ci-dessus puis cliquez sur le lien "Cette page en signet" dans le menu principal Codendi. Une nouvelle entre apparatra alors dans votre page personnelle que vous pouvez ditez afin de lui donner une description plus parlante. 2.2.2 La bote outils Un projet hberg sur Codendi a la possibilit d'utiliser de nombreux outils et services. Toute- fois tous les logiciels ne ncessitent pas un environnement aussi riche. Pour partager ou sauve- garder un court chantillon de code comme une macro, une fonction, un script shell un outil simple parat plus adapt. C'est prcisment le rle de la bote outils. La bote outils est accessible depuis le menu principal de Codendi sur la partie gauche ou la partie suprieure de l'cran (voir la Figure 1. La page d'accueil de Codendi [page 2]) Navigation dans les chantillons La page d'accueil de la bote outils classifie les chantillons par catgorie et par langages de programmation. Le nombre en regard du label d'une catgorie indique le nombre d'chantillons 7

17. Guide de l'utilisateur Codendi prsents dans la catgorie. Vous pouvez parcourir la collection d'chantillons de deux faons : Parcourir les catgories ou la classification par langage de programmation Utiliser la bote de recherche par mots-cls situe en bas gauche ou en haut droite de l'cran. La recherche s'effectue dans le titre et la description des chantillons. Les chantillons correspondants sont affichs avec leur identifiant unique (ID), leur titre, leur description ainsi que le nom de l'auteur. Veuillez noter qu'en cliquant sur le nom de l'auteur, vous pouvez immdiatement lui envoyer une suggestion ou une question par email. Figure 5. Liste des chantillons de code dans la catgorie 'HTML Manipulation' Crer un chantillon Pour soumettre un nouvel chantillon, cliquez sur le bouton "Crer un nouvel chantillon" dans le menu de la bote outils situ en haut de la page. Remplissez les champs titre et description (tout pointeur Web - ou URL - tap dans le champ description sera automatiquement transform en hyperlien par Codendi), le type de l'chantillon, sa catgorie et son langage de programmation. Si une catgorie ou un langage de programmation venait manquer, veuillez contacter l'quipe Codendi. Il est vivement recommand de fournir galement un numro de version. Il s'agit d'un champ de texte libre qui peut prendre n'importe quelle valeur. Utiliser un nom ou un numro de version est utile si vous pensez soumettre de nouvelles versions ultrieurement. Nous vous recommandons galement de porter ce mme numro de version dans le code source de l'chantillon pour que les utilisateurs puissent dterminer s'ils disposent de la version la plus rcente lors d'une pro- chaine visite la bote outils. L'chantillon de code lui-mme peut tre soumis soit par la biais d'une opration copier-coller 8

18. Guide de l'utilisateur Codendi dans la zone de texte prvue cet effet ou en tlchargeant un fichier. Dans la mesure du possible, il est prfrable d'utiliser la zone de texte car le code sera alors immdiatement visible sur la page Web lors de la consultation de la bote outils par d'autres utilisateurs. Il existe cependant des cas o le tlchargement est obligatoire, notamment pour les fichiers dont le format n'est pas directement lisible pour un utilisateur. Un exemple typique est le cas o l'chantillon est compos de plusieurs fichiers regroups dans une archive tar ou zip. Il peut aussi s'agir de fichiers propritaires ou binaires manant d'applications spcialises (par exemple le logiciel de simulation LabView). Dans tous les cas, ne jamais poster de fichier bi- naire ou byte-code pur rsultant d'une compilation C, C++, Java,... car la bote outils est avant tout faite pour partager et rutiliser des chantillons de code utiles tous. Mettre un chantillon jour Pour mettre jour un chantillon avec une nouvelle version du code, slectionnez l'chantillon soit en parcourant les catgories soit en effectuant une recherche par mots-cls. Cliquez sur lchantillon appropri, puis sur le lien "Soumettre un nouvelle version" en bas de page. Four- nissez une description des modifications, un nouveau numro de version et copier-coller ou t- lcharger le nouvel chantillon de code correspondant. Veuillez noter que bien qu'il s'agisse du mme chantillon, Codendi assigne un nouvel indentifiant chaque nouvelle version. Ainsi pour rfrencer la nouvelle version d'un chantillon dans un paquet d'chantillons (voir la section concernant le regroupement d'chantillons plus loin) vous devrez supprimer l'ancienne version et insrer la nouvelle). Dtruire un chantillon Procder comme indiqu prcdemment pour la slection de l'chantillon. Aprs avoir slectionn l'chantillon voulu, utilisez l'icne en forme de corbeille ( ) pour supprimer une ou plusieurs versions de l'chantillon Regrouper des chantillons Si vous avez soumis des chantillons qui ont un rapport entre eux il peut tre intressant de les regrouper au sein d'un paquet d'chantillons. Pour crer un paquet d'chantillons, cliquez sur "Crer un paquet" dans le menu situ en haut de la page. Fournissez un titre, une description, un type, une catgorie et un numro de version pour ce paquet. Aprs avoir soumis le formulaire, une nouvelle fentre apparat vous demandant d'indiquer les identifiants uniques (ID) des chantillons placer dans le paquet. Veillez avoir cette liste d'identifiants porte de main lors de la cration d'un paquet. Veuillez noter qu'il existe un indentifiant d'chantillon ainsi qu'un identifiant de version d'chantillon. Si vous tlchargez une nouvelle version d'un chantillon, l'identifiant de l'chantillon ne change pas, contrairement l'identifiant de la version de l'chantillon. Ainsi lorsque vous crez des paquets d'chantillons, assurez-vous d'utiliser l'identifiant de la nouvelle version. Mettre jour un paquet d'chantillons Comme un chantillon, un paquet peut tre mis jour. Pour se faire, procdez comme pour un 9

19. Guide de l'utilisateur Codendi chantillon, Il faut tout d'abord le rechercher dans la bote outils, le slectionner et enfin, cliquer sur l'icne d'dition. A partir de l vous pouvez ajouter ou supprimer des chantillons. Si vous voulez mettre jour le paquet en y intgrant une nouvelle version d'un chantillon, dtrui- sez d'abord l'ancienne version puis ajoutez la nouvelle en utilisant son identifiant de version (ID) propre (voir Section [page 9]). 2.2.3 Aide Index de l'aide Codendi est livr avec un guide de l'utilisateur trs complet dcrivant l'ensemble des outils et services. Un clic sur le lien "Index de l'aide" dirige l'utilisateur vers la table des matires du guide de l'utilisateur de Codendi. Ce mme guide est utilis sur l'ensemble du site Codendi par les liens "Aide" apparaissant dans quasiment tous les menus. Une version PDF de l'intgralit du guide de l'utilisateur est disponible dans la section "Documentation Site". Documentation Site Le lien "Documentation Site" est le point d'entre vers l'ensemble de la documentation relative l'ensemble du site Codendi. Son contenu est variable mais il comporte en gnral le guide utilisateur, des prsentations et d'autres documents importants maintenus par l'quipe Codendi. Li- sez-les attentivement. Canaux dveloppeurs L'un des objectifs prioritaires du site Codendi est de devenir le forum d'change des dveloppeurs logiciels quelle que soit l'organisation laquelle ils appartiennent. C'est pour cette raison que Codendi propose une srie de listes de distribution (appele Canaux Dveloppeurs) auxquelles toute personne, y compris un utilisateur non enregistr de Codendi, peut souscrire. Chaque canal est ddi un sujet particulier. La cration de nouveaux canaux est sous la responsabilit des administrateurs du site Codendi. Contactez les codendi- [email protected] si vous souhaitez faire une demande de cration. Les Canaux Dveloppeurs de Codendi prsentent un certain nombre de caractristiques int- ressantes : Les oprations d'abonnement et le dsabonnement au canal peuvent tre effectus par l'utilisateur lui-mme travers l'interface Web de Codendi. Tous les messages adresss au canal sont archivs et sont donc consultables tout moment. (Dans le futur, il sera aussi possible d'effectuer des recherches par mots-cls). Les abonns peuvent demander recevoir une version condense des changes plutt que chaque message individuellement. Forums de discussion Codendi Les forums de discussion Codendi proposent une alternative au Canaux Dveloppeurs. Il s'agit de forums d'change dont l'objectif est d'amliorer la communication entre les utilisateurs de Codendi et l'quipe en charge de l'administration du site. On y trouve des forums o il est possible de demander de l'aide, d'envoyer des suggestions, des demandes de nouvelles fonction- 10

20. Guide de l'utilisateur Codendi nalits ou de nouvelles catgories pour l'arbre des projets par exemple, etc Ces forums sont entirement bass web ce qui implique d'utiliser l'interface web de Codendi pour lire ou poster un message. Toutefois l'utilisateur a la possibilit de placer un forum sous surveillance afin de recevoir par email tous les changes qui ont lieu sur le forum. Contactez-nous En plus des forums de discussion, vous pouvez toujours utiliser le lien "Contactez-nous" pour contacter l'quipe Codendi. N'hsitez pas faire usage de ce lien ds que vous en ressentez le besoin. Nous sommes l pour vous aider. 2.2.4 La fonction de recherche Codendi vous permet d'effectuer une recherche par mots-cls sur quasiment toutes les informations disponibles sur le site. Lorsque vous vous trouvez sur la page d'accueil de Codendi vous pouvez rechercher des informations dans les ressources suivantes : Les projets logiciels : les mots-cls sont recherchs dans le nom et les descriptions courte et longue des projets. Ce mcanisme de recherche est trs complmentaire avec l'arbre des projets (voir Section 2.2.1 [page 6]). Bote outils : vous pouvez effectuer une recherche par mots-cls dans les chantillons de code disponibles dans la bote outils de Codendi (voir Section 2.2.2 [page 7]). La recherche porte sur le nom et la description. Vous pouvez ainsi trouver fa- cilement des chantillons de code qui rpondent vos besoins. Utilisateurs : dans ce cas la recherche s'effectue dans la liste des utilisateurs du site sur la base de leur nom d'utilisateur, leur nom complet ou leur adresse email. Wiki: Le Wiki est un outil collaboratif de rdaction (voir Chapitre 14. Service Wiki [page 174]). Vous pouvez effectuer une recherche en texte intgral dans les wikis. Cet outil de suivi : si vous utilisez un outil de suivi de Codendi, l'entre "Cet outil de suivi" apparat dans la bote de recherche, permettant ainsi d'effectuer une recherche par mots-cls dans les artefacts de cet outil de suivi. 2.3 Le tableau de bord de Codendi Par dfaut, le tableau de bord de Codendi se trouve sur la partie droite de la page d'accueil du site. Il donne une vue d'ensemble de l'activit du site travers plusieurs indicateurs : Statistiques Codendi : indique le nombre total de projets hbergs sur Codendi ( part ceux qui ont le statut priv ainsi que les projets de patron et les projets de test), le nombre d'utilisateurs enregistrs, le nombre total de tlchargements et le nombre de pages visites depuis l'ouverture du site. Top Tlchargements hier : donne la liste des projets qui ont fait l'objet d'un tlchargement la veille et en quelle quantit. Versions rcentes : donne une liste des versions de logiciels les plus rcentes postes sur le site par les diffrents projets. Si vous souhaitez connatre les dernires versions disponibles vous pouvez visiter la page d'accueil rgulirement. Codendi vous offre aussi le moyen de surveiller l'apparition de nouvelles versions pour un projet donn. Pour ce faire vous devez vous rendre sur la page de Sommaire du Projet (ou page 11

21. Guide de l'utilisateur Codendi d'accueil) et slectionner ensuite l'icne de surveillance ( ) plac proximit du nom du paquet logiciel qui vous intresse. Une fois le paquet sous surveillance, un email vous sera automatiquement envoy ds que l'quipe de projet publie une nouvelle version. Projets rcents : les 10 derniers projets enregistrs. En affichant cette liste de faon rgulire vous pouvez tre tenu inform de la cration de tout nouveau projet Codendi. Les plus actifs cette semaine : les 20 projets les plus actifs sur la semaine coule de 0 100%. La formule magique utilise pour ce calcul est une somme pondre de l'activit observe dans chacun des services utiliss par les projets. Elle prend en compte de nombreux indicateurs : le nombre de transactions CVS/Subversion, le nombre d'artefacts (bugs, tches...) soumis ou modifis, le nombre de versions de logiciel postes, etc En consultant cette liste vous aurez une bonne ide du degr d'activit des projets. En conclusion, nous vous recommandons vivement de visiter la page d'accueil de Codendi de faon rgulire. Ce faisant vous aurez un excellent aperu de ce qui se passe en matire de d- veloppement logiciel chez Xerox. En un mot comme en cent : Faites de Codendi la page par dfaut de votre navigateur :-) 12

22. Guide de l'utilisateur Codendi CHAPITRE 3 Devenir un utilisateur Codendi 3.1 Les classes d'utilisateurs Avant d'aborder les explications concernant le processus d'enregistrement d'un utilisateur, il est utile de passer en revue les diffrentes classes d'utilisateurs de Codendi. Il en existe quatre : Les utilisateurs anonymes : il s'agit l des utilisateurs qui visitent Codendi pour la premire fois ou qui n'ont pas pris la peine de se connecter en arrivant sur la page d'accueil. Par dfaut, les utilisateurs anonymes peuvent parcourir le site Codendi mais de nombreux services et ressources Codendi ne leur sont pas accessibles (par exemple l'accs aux logiciels eux-mmes, les fonctions de surveillance, etc). Nous vous conseillons donc vivement de vous enregistrer sur Codendi si vous voulez en tirer le meilleur parti. Les utilisateurs enregistrs : une fois votre compte utilisateur enregistr (voir plus bas) vous pouvez utiliser votre nom d'utilisateur et votre mot de passe pour vous au- thentifier auprs de Codendi. Les utilisateurs enregistrs ont accs tous les projets de Codendi sauf si l'administrateur du projet en a dcid autrement. Ils bnficient aussi d'une page personnelle, de la capacit surveiller des forums et des paquets logiciels et de la notification par email des mises jour des artefacts (bugs, tches,...) dans lesquels ils sont impliqus, etc Les membres d'un projet : ce sont les utilisateurs participant aux activits d'un projet hberg sur Codendi. Pour devenir membre d'un projet vous devez d'abord devenir utilisateur enregistr et, ensuite, demander l'administrateur du projet de vous admettre parmi les membres. Les membres d'un projet sont la plupart du temps membres de l'quipe de projet mais ne sont pas ncessairement des dveloppeurs. Ils peuvent tre en charge de l'activit de support ou de contrle qualit, de la gestion de la documentation ou de la gestion du projet lui-mme. Les membres d'un projet se voient souvent assigns des droits diffrents par l'administrateur du projet selon leur rle (voir Chapitre 6. Administration d'un projet [page 25] pour plus de dtails). Les administrateurs d'un projet : les utilisateurs enregistrs qui crent un nouveau projet sur Codendi hritent du rle d'administrateur de ce projet. Les administrateurs d'un projet disposent des pleins pouvoirs sur ce projet sauf en ce qui concerne la suppression complte d'un projet - une chose trs rare - que seuls les administrateurs du site peuvent faire. A n'importe quel moment dans le cycle de vie du projet, l'administrateur historique du projet peut assigner (ou rvoquer) ce mme rle d'autres membres du projet. Les utilisateurs restreints : il s'agit l de membres ou d'administrateurs de projet dont 13

23. Guide de l'utilisateur Codendi les droits d'accs sont restreints : ils n'ont accs qu'aux projets dont ils sont membres et ne voient pas les autres projets, quels qu'ils soient. Ce rle particulier est en gnral ac- tiv sur les sites Codendi mlant utilisateurs internes et externes sur le mme serveur dans le but de cantonner les utilisateurs uniquement aux projets dans lesquels ils ont une responsabilit. 3.2 Enregistrement des utilisateurs Comme suggr plus haut, la premire chose faire pour un nouveau venu sur Codendi consiste crer son propre compte. Crer son propre compte ne vous engage aucunement hberger vos projets sur Codendi mais vous donne plus de possibilits lorsque vous parcourez le site et permet Codendi de personnaliser les informations qui vous sont prsentes. S'enregistrer sur Codendi est simple et rapide : 1. Slectionnez le lien "Nouveau compte". 2. Remplissez les champs suivants (ceux marqus d'un astrisque sont obligatoires) : a. Nom de login : votre nom d'utilisateur. A noter que sur certains systmes Co- dendi connects un annuaire d'entreprise le nom d'utilisateur peut tre impos (voir plus loin). b. Mot de passe : 6 caractres minimum rpter deux fois pour viter toute erreur de frappe. c. Nom complet : rappelez-moi votre nom - s'il vous plat. d. Adresse email : suivant la configuration du site, les adresses emails considres comme valides peuvent se limiter au domaine Xerox ou l'un de ses sous- domaines. Vrifiez bien que votre adresse email est correcte faute de quoi vous ne recevriez pas la demande de confirmation de votre enregistrement. e. Fuseau horaire : choisissez le fuseau horaire dans lequel vous vivez. C'est une information importante car Codendi stocke tous ses marqueurs de temps en temps universel (GMT) et s'appuie sur le fuseau horaire fourni par l'utilisateur pour prsenter les dates et heures en temps local sur les diffrentes pages Web. f. Annonces site : cochez cette case si vous souhaitez recevoir les informations concernant les mises jour du site Codendi. Le trafic est trs faible et nous vous recommandons vivement de cocher cette case. Les notifications reues traitent des nouvelles fonctionnalits disponibles, des plages d'indisponibilit pour raison de maintenance, des vnements importants dans la vie du site, etc g. Annonces site supplmentaires : cochez cette case pour recevoir des messages moins importants concernant la vie du site. Vous pouvez cocher cette case sans crainte d'tre submerg de messages car le trafic est extrmement rduit. 3. Peu aprs avoir valid l'enregistrement de votre compte utilisateur un email doit vous parvenir vous demandant confirmation. En cliquant sur l'URL contenu dans ce message, vous ferez apparatre un formulaire vous demandant nouveau votre nom d'utilisateur et votre mot de passe. S'ils correspondent bien ceux que vous avez initialement choisis, votre compte utilisateur est dfinitivement valid et vous tes dsormais connect Codendi. Coup de pouce : serveur Codendi reli un annuaire d'entreprise Si votre serveur Codendi est connect un annuaire d'entreprise le processus d'enregistrement est encore plus simple : il vous suffit de taper votre nom d'utilisateur LDAP et votre mot de passe et Co- dendi extraira automatiquement le reste des informations vous concernant dans l'annuaire : adresse email, nom complet, etc 14

24. Guide de l'utilisateur Codendi Ce processus d'enregistrement en deux tapes a t mis en place pour des raisons de scurit. En supposant qu'un utilisateur cre un compte avec une fausse adresse email, le message ne lui parviendra pas et la validation du compte ne pourra se faire. Pour les sites situs derrire un pare-feu cela implique aussi qu'un compte ne peut-tre valid depuis l'extrieur. Coup de pouce : que faire si j'oublie mon mot de passe ou mon nom d'utilisateur ? Tout d'abord ne paniquez pas et, surtout, ne crez pas un nouveau compte dans la foule. Si vous avez oubli votre mot de passe, allez sur la page de connexion au site Codendi et suivez le lien [Mot de passe perdu ?]. Un formulaire apparat qui vous demande votre nom d'utilisateur. Aprs l'avoir soumis vous recevrez un email contenant un URL. Aprs avoir suivi cet URL et avoir choisi un nouveau mot de passe, vous pourrez nouveau accder au site. Et que se passe-t-il si j'ai aussi oubli mon nom d'utilisateur ? L a devient srieux ! Dans ce cas utilisez la bote de recherche par mots-cls, slectionnez l'option "Utilisateurs", tapez tout ou partie de votre nom de famille et voyez si les rsultats retourns vous permettent de retrouver votre nom d'utilisateur. Si oui appliquez alors la procdure en cas de perte de mot de passe, si non contactez l'administrateur du site. 3.3 Connexion et page personnelle Pour vous connecter au site Codendi, rendez vous sur l'URL http://www.codendi.org et cliquez sur le lien "Se connecter". Aprs vous tre authentifi, Codendi vous prsente votre Page Per- sonnelle (Figure 6. La page personnelle d'un utilisateur Codendi [page 15]. Vous pouvez tout moment retourner sur cette Page Personnelle en slectionnant le lien "Ma Page Personnelle" dans le menu Codendi. Votre page personnelle est une plaque tournante partir de laquelle vous pouvez rayonner vers d'autres espaces de travail et d'information de Codendi. Vous y trouverez les artefacts (bugs, tches, etc...) qui vous sont assigns ou que vous avez soumis. Vous pouvez ainsi trs facile- ment suivre l'volution des artefacts dont vous tes en charge dans vos projets ou ceux que vous avez soumis d'autres projets et que vous tes impatient de voir traits. 15

25. Guide de l'utilisateur Codendi Figure 6. La page personnelle d'un utilisateur Codendi Codendi vous permet de personnaliser votre page votre convenance. Le contenu de la page est constitu de widgets. Tous les widgets peuvent tre dplacs (1), ferms ou supprims (2). Certains d'entre eux peuvent fournir un flux rss (3) ou des prfrences peuvent tre choisies (4). Les widgets peuvent tre ajouts grce au lien "Ajouter des widgets" (5). Voici une liste non- exhaustive de widgets disponible pour votre page personnelle : Fichiers sous surveillance liste les fichiers que vous surveillez, par projet. Pour inter- rompre la surveillance, il vous suffit de cliquer sur la corbeille ( ) ct de l'item concern. Forums sous surveillance liste les forums que vous surveillez, par projet. Pour inter- rompre la surveillance, il vous suffit de cliquer sur la corbeille ( ) ct de l'item concern. Mes artefacts liste les artfacts soumis par vous ou qui vous ont t assigns, par projet. Mes favoris liste vos pointeurs favoris (pointeurs sur vos pages prfres de Codendi ou externes). A noter que ces pointeurs peuvent tre trs sophistiqus. Ils permettent par exemple de mmoriser une requte multi-critres effectue sur un outil de suivi. Mes projets liste les projets auxquels vous appartenez. La slection d'un de ces projets vous amne sur sa page sommaire. Sondages: Sondage site en cours auxquels vous n'avez pas encore particip. RSS Reader vous permet d'inclure dans votre page personnelle des fils rss (ou atom) publiques. 3.4 Gestion de compte Lors de la phase d'enregistrement vous avez fourni un certain nombre d'informations vous concernant. Ces informations peuvent tre modifies tout moment en slectionnant le lien "Mon compte" dans le menu de Codendi. La plupart des informations modifiables sur la page "Mon compte" vous paratront videntes. Nous voulons cependant attirer votre attention sur certaines d'entre elles : Voir mon profil de comptences : un utilisateur peut publier son CV sur Codendi. Le but est de permettre aux autres utilisateurs de mieux vous connatre vous et votre ex- pertise technique. Cls SSH partages : ce champ se rapporte au service Compte Shell. Lorsque vous tes utilisateur enregistr, le serveur Codendi vous offre un compte shell personnel qui utilise le mme nom d'utilisateur et le mme mot de passe que le compte Web. Pour au- tomatiser la procdure de connexion ce compte vous pouvez partager votre cl pu- blique SSH avec Codendi. Ainsi vous vous viterez la saisie systmatique d'un nom d'utilisateur et d'un mot de passe. Plus de dtails sur Section 18.1 [page 197]. 16

26. Guide de l'utilisateur Codendi 3.5 Prfrences Vos prfrences utilisateurs sont disponibles dans Ma page personnelle -> Prfrences. Voici les prfrences que vous pouvez dfinir : "Souviens-toi de moi" : par dfaut, votre session de travail courante sur Codendi s'achve ds que vous stoppez votre navigateur Web. Au prochain dmarrage, vous devrez nouveau vous identifier. En cochant cette case vous demandez Codendi de se souvenir de votre identit entre deux sessions de travail moins, bien sr, que vous ne vous dconnectiez explicitement en utilisant le lien "Se dconnecter". Pour des raisons de scurit nous vous recommandons de n'utiliser cette fonctionnalit que si vous disposez d'une machine personnelle. Sparateur CSV: Codendi vous permet d'importer et d'exporter des donnes de vos projets (Voir Section 6.11 [page 39] pour plus de dtails). Le format d'import et d'export utilis est le format CSV. Comme la norme CSV n'est pas implmente de la mme manire dans tous les logiciels, vous avez la possibilit de dfinir votre sparateur CSV. Les diffrents sparateurs disponibles sont : la virgule (,) : le sparateur par dfaut. Le point-virgule (;) : utilis par dfaut par la version franaise d'Excel. Tab (tabulation). Format de date CSV: Codendi vous permet d'importer et d'exporter des donnes de vos projets (Voir Section 6.11 [page 39] pour plus de dtails). Le format d'import et d'export utilis est le format CSV. Comme la norme CSV n'est pas implmente de la mme manire dans tous les logiciels, vous avez la possibilit de dfinir votre format de date CSV. Les diffrents formats disponibles sont : mois/jour/anne : le format par dfaut (gnralement utilis aux Etats-Unis). jour/mois/anne : utilis par dfaut dans la version franaise d'Excel. Ce format sera utilis lors de l'export des artfacts. Il sera galement utilis lors de l'import. N'oubliez donc pas de vrifier vos donnes dates avant d'importer. Le systme attend des dates au format dfini dans vos prfrences. 17

27. Guide de l'utilisateur Codendi CHAPITRE 4 Crer un nouveau projet Vous tes dsormais un utilisateur Codendi frachement enregistr et vous voulez vous simpli- fier la vie ainsi que celle de vos quipes de projet. En d'autre termes vous voulez : viter le travail et les dpenses lis la mise en place et la maintenance de votre propre infrastructure (serveurs de dveloppement, serveur de sauvegarde, etc...) Ne pas payer le prix fort pour des outils commerciaux de contrle de version, de suivi d'anomalies ou de gestion des tches. Mettre rapidement en place un environnement de projet que vous pouvez partager avec vos collgues, vos partenaires, vos sous-traitants ou vos clients tout en gardant vos informations sous contrle. Rendre votre organisation globalement plus productive en permettant d'autre de r- utiliser vos composants logiciels si vous le dsirez. Si l'un de ces points vous parat pertinent pour votre activit alors vous devriez absolument h- berger vos projets sur Codendi. Voyons comment faire. 4.1 Enregistrer un projet Avant de crer un nouveau projet vous devez avoir le statut d'utilisateur enregistr (voir Section 3.1 [page 13]). Vous pouvez alors vous connecter et slectionner le lien "Enregistrer un projet" dans le menu de Codendi. L'enregistrement d'un projet est un processus qui prend moins de 10 minutes : Enregistrement d'un projet Il s'agit d'informations propos des services Codendi. Lisez les attentivement. N'oubliez pas de lire et d'accepter les Conditions gnrales d'utilisation. Nom du projet Indiquez le nom court et le nom complet du projet. Lisez attentivement les instructions fournies. Le nom complet peut tre modifi tout moment dans la vie du projet mais pas le nom court.2. Rflchissez donc bien avant de choisir ! Patron de projet Vous avez dj soumis un projet Codendi et voudriez rutiliser la mme configuration (services, outils de suivi, documents, rfrences, ...) ? Vous pouvez convertir votre an- 2 En fait il peut l'tre mais cela ncessite l'intervention des administrateurs du site. 18

28. Guide de l'utilisateur Codendi cien projet en patron de projet (voir Section 6.5 [page 27]) et vous le retrouverez sur cette page dans la liste des patrons de projet disponible. Choisissez votre ancien projet comme patron et votre nouveau projet aura les mmes services configurs de la mme manire que votre ancien projet. Si vous ne voulez pas rutiliser un patron spcifique gardez simplement le Patron Codendi par dfault coch et continuez l'enregistrement. Description du projet C'est l que tout commence vritablement ! En donnant une description de votre projet. Il est important que cette description soit aussi prcise que possible pour que tous les intervenants sachent de quoi il est question. Vous pouvez aussi fournir des informations lies la proprit intellectuelle comme des propositions d'inventions ou des brevets ou bien tablir la liste des logiciels ncessaires au bon fonctionnement de votre projet. Le dernier champ est libre : vous pouvez y faire figurer toute information qui vous parat pertinente pour votre projet et ses utilisateurs. Services du projet Vous pouvez slectionner les services que vous voulez activer. Notez que vous pourrez changer ces prfrences par la suite, une fois votre projet cr. Catgorisation du projet Veuillez slectionner jusqu' trois valeurs pour chaque catgorie de ce projet. Cela per- mettra aux utilisateurs de retrouver rapidement votre projet. Si votre projet n'a pas besoin de toutes les catgories, slectionnez simplement "Aucune slection". Si vous avez utilis un patron de projet qui a dj t classifi, vous allez retrouver ses catgories ici. Vous pourrez nouveau modifier cette classification quand vous le souhaitez. Vous pouvez catgoriser votre projet suivant sept critres qui sont ceux utiliss dans l'arbre des projets (voir Section 2.2.1 [page 6]). Politique d'change NOTE : cette tape ne s'applique que si vous crez un projet public. Si c'est le cas, le choix par dfaut est celui que vous devez conserver savoir la "Politique d'Echange de Xerox". Comme expliqu plus haut, l'quipe Codendi assiste du dpartement lgal de Xerox ont cr et valid ces rgles d'change. Un certain nombre de licences Open Source sont aussi mentionnes. Enfin vous pouvez aussi spcifier vos propres termes de licence. Confirmation finale Lors de cette dernire tape, un rcapitulatif des diffrentes informations saisies vous est prsent pour approbation. Mais ne vous inquitez pas : vous pourrez encore modifier ces informations une fois votre projet approuv. Aprs validation de l'enregistrement du projet, l'quipe Codendi doit le revoir et l'approuver, le rejeter ou vous demander plus d'information. Ce processus ne prend pas plus de 24 heures dans le pire des cas et moins d'une heure la plupart du temps. Rares sont les projets rejets donc il y a peu de crainte avoir... Aprs approbation du projet, vous recevrez un email rsu- mant les caractristiques de votre projet ainsi qu'un certain nombre de pointeurs dont un vers le "Sommaire du Projet". Conservez le dans vos signets favoris. 19

29. Guide de l'utilisateur Codendi 4.2 Configuration post-enregistrement La premire chose faire aprs avoir reu confirmation de l'enregistrement du projet consiste se rendre sur le page du "Sommaire du Projet" (URL inclus dans le message de notification) et achever la configuration. Il y au minimum deux actions prendre : Classer votre projet dans l'arbre des logiciels Si vous ne l'avez pas fait lors de l'enregistrement de votre projet, nous vous invitons for- tement le faire maintenant ! La catgorisation de votre projet apparat sur la page de "Sommaire" du projet. Pour catgoriser le projet, cliquez sur le lien "le catgoriser" et renseignez les diffrentes catgories. Constituer l'quipe de projet Une fois le projet cr, le crateur hrite du rle d'administrateur de ce projet. Il est de sa responsabilit de constituer l'quipe en dsignant les membres du projet et en dfi- nissant leurs permissions. Pour se faire il faut accder la page d'administration du projet et saisir le nom de tous les utilisateurs qui doivent tre promus membres du projet et ensuite dfinir leurs permissions. Coup de pouce : vous ne trouvez pas la bonne catgorie ? Contactez-nous Plutt que de mettre en place une hirarchie de valeurs lourdes et complexes pour chacun des sept critres de classification de l'arbre des projets, l'quipe Codendi a dcid de faire voluer cette hirarchie au fur et mesure de l'apparition de nouveaux projets. Si vous ne trouvez pas la valeur qui vous convient dans l'un des critres de catgorisation, n'hsitez pas contacter l'quipe Codendi via le lien "Contactez-nous" situ dans la section Aide du menu principal de Codendi ou en soumettant une demande dans l'un des forums de discussion du site. 20

30. Guide de l'utilisateur Codendi CHAPITRE 5 Sommaire du projet La page de Sommaire du Projet est le point d'entre d'un projet

Technology

Guide Utilisateur Codendi 4.0