Utilisation des Services scenari-platform.org

Structuration des services

Les projets scenari-platform.org :

• Espace de communication projet SCENARI : aider les auteurs / modélisateurs / développeurs a découvrir, s'informer, et faire progresser le projet SCENARI
• Espace de communication pour les projets de modèles et les développements particuliers : Faire connaître et faciliter le développement des projets SCENARI

Les personnes : les utilisateurs

• 1 seul compte par utilisateur (sauf pour forum)
• Ne pas avoir peur d'utiliser ou de demander (si vous faites une erreur, au pire votre message sera mauvais sur la forme, les autres utilisateurs seront la pour rectifier et vous expliquer)

Les moyens de scenari-platform : les services

• SVN (partage de fichiers code et modèles)
• Mailing list (communication par messages mails)
• Forum (communication par messages web)
• Wiki (espace de documentation "au brouillon")
• Bugtracking (gestion et suivi des bugs)
• Site web
• Flux RSS / aggrégateur (notifications "presque temps réel des événements" sur un projet)

Point d'intersection

• page principale http://scenari-platform.org : liste projets/services affichée dans la frame a droite. L'affichage d'un site web avec des frames est contraignant, mais c'est la seule méthode efficace pour regrouper les principaux services des principaux projets dans un même menu. Si vous souhaitez naviguer sur un ensemble de pages sans frames (pour par exemple copier l'URL de la page courante avec firefox, faites un clic droit sur le contenu, choisissez "ce cadre" > "uniquement ce cadre" dans le menu qui apparaît.

• page d'administration : http://scenari-platform.org/admin

Des projets Ouverts

• Ne s'applique qu'aux modèles Open Source (publiques et distribués librement sur internet).
• Pour les autres, possibilité d'activer les services indépendamment (par ex : repository SVN privé), mais c'est hors spectre initial de scenari-platform.
• Garder toujours à l'esprit que normalement, toutes les données que vous entrez dans un service sont publiques (même les fichiers supprimés des repositorys subversion peuvent être récupérés)

Votre compte

Cette partie décrit la gestion des comptes pour SVN, le wiki, le bugtracking :

1. Si vous n'avez pas de compte, vous pouvez en créer un avec trac : http://scenari-platform.org/trac/sandbox/register , mais les nouveaux comptes n'ont aucun droit automatique, il faut que ces droits soit attribués par des membres d'un projet, ou par des admins scenari-platform.org
2. Vous pouvez changer votre mot de passe sur la page d'administration, ne mettez pas quelque chose de trop simple ou un mot de passe de 4 lettres que d'autres personnes utilisent : http://scenari-platform.org/admin
3. Si vous êtes membres d'un projet, vous pouvez accepter d'autres utilisateurs déjà existant en tant que membres de ce projet sur la page d'administration. Cela veux dire qu'ils auront des permissions d'écriture sur le répertoire SVN, des autorisations de suppression de page wiki / rapport de bugs dans trac, et surtout la possibilité technique de transmettre ces permissions, ou de les enlever a n'importe quel autre membre. Evidement, n'acceptez que des personnes de confiance, et consultez le responsable du projet avant d'effectuer cette tâche.
4. pour le wiki, le SVN et le bugracking : 1 utilisateur = 1 compte : Si vous travaillez sur plusieurs projets vous n'avez besoin que d'un seul compte ; si vous êtes plusieurs personnes à travailler sur le même projet il faut un compte par personne
5. En cas d'oubli de mot de passe ou autre problème, contactez un administrateur de la plateforme technique : Stéphane Poinsart stephane.poinsart@utc.fr , Antoine Magnier, Sylvain Spinelli

1 + 3 -> vous pouvez si vous le souhaitez gérer les permissions des projets publics sans action de la part d'un administrateur scenari-platform.org

Attention !
Soyez soucieux de la sécurité de votre mot de passe et des membres que vous ajoutez au projet La gestion de projet décrite ci dessus concerne uniquement les projets public scenari-platform.org (du répertoire /svn). Les projets privés (du répertoire /svn-private) n'ont pas d'interface de gestion, demandez les autorisations au cas par cas

SVN

• guide subversion : http://scenari-platform.org/trac/scenari/wiki/subversion

Environnement trac : Wiki / Bugtracking

Trac est un environnement de gestion du développement d'un projet. Il a pour objectif d'être très proche des méthodes de développements (intégration subversion, roadmaps...), mais assez simple pour que les utilisateurs non spécialistes puissent l'utiliser.

Un environnement de test est installé ici, si vous voulez créer des pages de test sur le wiki ou de "faux" rapports de bugs.

• http://scenari-platform.org/trac/sandbox

Particularité pour le projet principal

Le projet scenari-platform.org est découpé en 2 environnements trac :

• http://scenari-platform.org/trac/scenari/ : un environnement de documentation wiki pour les utilisateurs / modélisateurs de base
• http://scenari-platform.org/trac/dev-core/ : un environement de bugtracking / SVN pour les personnes très proche du projet et les développeurs

(mais les 2 sont publiques)

Le wiki

• Le Wiki est un espace "brouillon de documentation collaboratif" publié sur internet que tout le monde peu modifier librement
• Les adresses sont stables, c'est a dire que vous pouvez par exemple, envoyer un email qui introduit une fonctionnalité, et la décrire plus complétement dans une page de wiki.
• Pour effectuer les opérations de modification du contenu, il faut créer ou avoir un compte, mais aucune permission spéciale n'est requise. Sur la barre de menu en rouge, utilisez le bouton "Login" ou "Register". lorsque vous utilisez le proxy de l'UTC depuis l'intérieur, il faut parfois faire login 2 fois pour que la connexion se réalise.
• Pour la mise en forme, ce n'est pas aussi simple qu'un traitement de texte, la syntaxe d'édition du wiki est expliquée ici : WikiFormatting
• Si c'est trop compliqué pour vous, que vous êtes un utilisateur trop occasionnel, tapez le texte sans mise en forme, et une âme charitable s'occupera de la présentation
• Rappelez vous qu'il vaut mieux mal placer une page, faire une page incomplète ou même juste un plan que de ne rien écrire du tout, c'est un brouillon Mais dans ce cas, n'hésitez pas à faire une note dans la page du type "à mettre dans la bonne catégorie", "compléter partie X", "ajouter image Y"... Attention cependant, le minimum est de placer la page dans le bon wiki (ne vous lancez pas dans une description détaillée des items de SimpleSlideShow si vous êtes dans le wiki général pour scenari), chaque projet important devrait avoir son propre wiki.
• Pour retrouver des pages, vous avez plusieurs moyens :
  • les listes de toutes les pages "Index by Title" et "Index by Date" (boutons en haut a droite)
  • la fonction "Search"
• Si vous êtes membre du projet, vous pouvez revenir en arrière sur les pages ou supprimer une page : attention, ces opérations sont irréversibles
• En général, il n'y a pas besoin de supprimer une page : vous pouvez ajouter un avertissement du type "Attention, cette page est obsolète pour la raison X ou Y". Les personnes qui tenterons de se connecter à la page auront cette explication plutôt qu'un message du style "page not found".

Contenu / saisie d'un ticket

Vérifiez Bien qu'un ticket identique n'existe pas déjà (fonction "Search" ou dans la liste des tickets)

Pour un utilisateur "non membre", la saisie d'un ticket a pour objectif d'être simple. Un visiteur qui ne possède aucune permission sur le projet devra en général fournir les informations suivantes :

• type : Le type du ticket
  • defect : une anomalie, une erreur, un bug
  • enhancement : une nouvelle fonctionnalité qu'il faudrait ajouter
  • task : une tache à accomplir pour les développeur (par exemple, refaire une image...). En général, seul les membres du projet utilisent ce type
• Short summary : Le titre du ticket, il doit résumer le bug en quelques mots, et permettre aux développeur de visualiser le bug
  • bons exemples : "faute d'orthographe 'atelliers'", "copier-coller des listes simples", "images inline pour les générateur flash"
  • mauvais exemples, tout ce qui est trop vague : "erreur de gestion des ateliers", "problème avec les listes dans l'éditeur", "les images inlines ne marchent pas"
• Full description : les informations complète sur le ticket, vous devez indiquer :
  • Le contexte complet : en fonction des cas, par exemple dans le cas d'un bug sur un programme SCENARI :
    • votre système d'exploitation
    • les particularités de votre système (biprocesseur / dual core)
    • si des autres programmes interviennent, indiquez lesquels (par exemple, si vous utilisez un générateur OD, indiquez votre version d'OpenOffice.org)
  • ce que vous avez fait, la manière de reproduire l'erreur ou d'arriver à la constater exemple : "j'ai créer un item quelconque avec un flowall dans SCENARItest, j'ai créé une liste simple avec le bouton "envelopper paragraphe", et je l'ai copié avec sélection + bouton droit, puis je tente de la coller dans un nouveau paragraphe"
  • ce qui se passe : "rien n'est inséré dans le nouveau paragraphe"
  • ce qui aurait du se passer : "la liste copiée aurait du être ajouté au nouveau paragraphe"
  • toute autre information utile
• Version : la version et l'outil utilisé

Il est très important de suivre l'évolution du ticket pour l'utilisateur qui l'a créer, les développeurs ont peut être besoin d'informations complémentaires. Dans ce cas, ne pas hésiter a poster des commentaires supplémentaires.

Pour les utilisateur membres de ce projet, des champs "administratifs" en permettent un meilleur suivi

• Priority : la priorité que vous accordez pour la résolution de ce bug (liste d'après le système bugzilla)
  • Blocker : Blocks development and/or testing work
  • Critical : crashes, loss of data, severe memory leak
  • Major : major loss of function
  • Minor : minor loss of function, or other problem where easy workaround is present
  • Trivial : cosmetic problem like misspelled words or misaligned text
• asigned to : responsable de la résolution du ticket (en général le développeur ou le modélisateur qui doit corriger le problème)
• Milestone : la "version cible" de la correction, version du programme à laquelle les utilisateur pourront constater la résolution du ticket. Tant que le bug n'est pas réparé, c'est une indication de l'objectif, pas une information définitive, l'intégration dans les versions suivantes peuvent être repoussées.

Les opérations sur ticket

Un ticket suis un cycle de vie préci, il commence a l'état "new", et subit différentes opérations qui modifient son état

• Leave as new : part défaut aucune opération, si vous voulez changer une propriété ou ajouter un commentaire, conservez ce choix
• Accept ticket : vous ajoutez l'état "accepted" a ce bug, et vous vous l'assignez a vous même si ce n'est pas le cas. n'acceptez pas des bugs si c'est quelqu'un d'autre qui doit s'en occuper
• Resolve as : marque la fin de la vie du ticket, avec l'état final suivant :
  • fixed : vous avez corrigé ce bug ou ajouté la fonctionnalité, et commité le correctif qui sera effectif dans la milestone prévue
  • invalid : le bug n'a rien a voir avec SCENARI, ou l'auteur du ticket ne fourni pas les informations nécessaires
  • wontfix : le bug existe ou la fonctionnalité proposé est manquante, mais les développeurs ont une raison de ne pas traiter le ticket
  • duplicate : le même bug ou un bug ayant la même origine a déjà été posté, dans ce cas c'est le plus récent qui est marqué comme "duplicate"
  • worksforme : en se plaçant dans les mêmes conditions que l'auteur du ticket, il est impossible de reproduire l'erreur ou le problème

Roadmaps

C'est une vue par Milestone de l'évolution du projet. Le but de la timeline est d'aider à boucler les Milestones plus proches et d'avoir une vue sur les Milestone les plus lointaines. Exemples :

• vue complète de la Roadmap : http://scenari-platform.org/trac/dev-core/roadmap
• vue d'une seul Milestone : http://scenari-platform.org/trac/dev-core/milestone/3.3?by=priority

Pour visualiser la liste des tickets ouvert ou fermés associés a une milestone : un clic la partie correspondante de la barre de progression

La timeline

C'est un affichage chronologie jour par jour des événements sur un seul projet, exemples :

• http://scenari-platform.org/trac/scenari/timeline
• http://scenari-platform.org/trac/showlib/timeline
• http://scenari-platform.org/trac/opale/timeline

En clicant sur les liens, on obtient d'autres informations :

• pour les commits : les noms des fichiers modifiés, et les lignes qui présentent des différences
• pour les éditions wiki : un lien vers la dernière version
• pour les tickets : un lien vers le ticket

Flux RSS

Les flux RSS sont des mécanismes de suivi d'événements. L'environnement trac intègre complètement ce principe et presque chaque page donne lieu a un flux RSS avec les infos de cette page, mise a jours presque en temps réel.

Il y a 2 méthodes d'exploiter les Flux RSS :

• Par l'aggrégateur http://scenari-platform.org/aggregator qui regroupe tous les flux des projets importants, et synthétise les activités de commits, d'édition wiki, et d'évolution de tickets jour par jour. En cliquant sur un dossier, on obtient uniquement les informations de cette catégorie.

• Par un autre programme supportant le RSS, en vous "abonnant" au flux :
  • Vous pouvez ajouter des flux RSS a firefox en cliquant sur l'icône orange a l'intérieur de la bare d'adresse du navigateur. Mais c'est juste une méthode de "bookmark intelligents" et l'information n'est pas vraiment synthétisé.
  • Vous pouvez consulter dans Thunderbird, qui les traite un peu comme des emails. Pour cela, choisissez en adresse de flux celle que vous obtenez en copiant l'adresse du lien des icônes oranges XML en bas des pages.
  • Il existe plein d'extensions firefox ou de programmes individuels pour gérer les flux RSS (compléter cette liste)
• Vous pouvez combiner les 2 méthodes, et vous abonner a l'aggrégateur

Forum / mailing list

• les mailing listes et le forum sont pour la pluspart synchronisées (l'envoi d'un message dans une ML entraîne un poste automatique avec le même contenu dans le forum et vice-versa). Vous pouvez utiliser l'un ou l'autre, et tout le monde vous lira. Il y a parfois des défauts de mise en forme entre ces 2 mondes, si vous n'arrivez pas a lire un mail, cliquez sur le lien pour l'ouvrir dans le forum par exemple.
• adresse forum : http://scenari-platform.org/forum
• rappel de vocabulaire forum :
  • un post ou réponse : 1 message
  • un topic : = thread, 1 post et toutes les réponses à ce post, ex : http://scenari-platform.org/forum/viewtopic.php?t=140
  • un forum : une liste de topics, ex : http://scenari-platform.org/forum/viewforum.php?f=21
  • une catégorie : une liste de forums, ex : http://scenari-platform.org/forum/index.php?c=7
  • "le forum" : une liste de catégorie ou le programme complet qui gère le service de forum, attention c'est un piége, le mot a 2 usages, ex : http://scenari-platform.org/forum/

Interface du forum

• Inscription : http://scenari-platform.org/forum/profile.php?mode=register (les login/mots de passe ne sont pas partagés entre le forum et subversion, vous devez vous inscrire sur le forum si vous ne l'avez jamais fait). Les noms de compte pour les inscriptions doivent être du type prénom.nom sur le forum.
• suivre les messages : si vous êtes inscrit, consultez la page "voir les nouveaux messages depuis votre derniere visite" (lien en haut a droite de la liste des forum). Si vous voulez trouver un message d'après son contenu ou son auteur, utilisez la fonction rechercher.
• envoyer un message : choisissez le bon forum pour poster votre message et cliquez sur le bouton nouveau :
• Répondre a un post :
• Mettre en forme le message : Ce n'est pas obligatoire, et moins intuitif qu'un traitement de texte, mais vous pouvez mettre un texte en gras en l'encadrant de balises [b]...[/b] ou indiquer qu'une partie de texte est en citation en le plaçant dans des balises [quote]...[/quote] par exemple. Les boutons de la barre d'outil le font pour vous.

Utilisation des mailing lists

• inscription : doit se faire un par un à chaque mailing list, l'adresse d'inscription est du type nomdelaliste-subscribe@scenari-platform.org (on ajoute "-subscribe" par rapport a l'adresse d'utilisation). il faut envoyer un mail vide a cette adresse, puis répondre à un mail de confirmation pour que le compte soit validé.
• pour envoyer un message : envoyez un mail à l'adresse de la mailing list (voir ci dessous)

Les différents sujets

• announce@scenari-platform.org : Réservé aux annonces officielles, tous les messages envoyés sur cette listes sont transmis a Stéphane Crozat, et c'est lui qui décide de leur publication
• modeller@scenari-platform.org : Reprise de l'ancienne liste qui cible les modélisateurs et l'utilisation de SCENARIbuilder
• showlib@scenari-platform.org, simpleslideshow@scenari-platform.org, opale@scenari-platform.org ... : les informations sur les modèles les plus actifs
• plateforme-technique@scenari-platform.org : des informations sur l'évolution des services
• dev-core@scenari-platform.org : pour les programmeurs SCENARI ou ceux qui suivent le développement de très prés
• dev-flash@scenari-platform.org ... : pour les programmeurs de composants ou ceux qui suivent le développement de très prés