Contribuer au Projet Veda.

[Rouliass]

Salut la foule,

Ayant un peu de temps devant moi, je vais tenter de mettre ici un tutoriel pour contribuer (créer/modifier un test, créer/modifier un commentaire) au Projet Veda. Si ça peut encore servir ...

On va essayer de faire ça simple avec des screenshot. Pour le moment, ce post est en chantier, donc non terminé et il sera complété au fil de l'eau.

I. Créer un compte sur Github.

(Et comprendre un peu ce qui s'y passe.)

On commence par se connecter à l'adresse: https://github.com/join.

Là c'est simple, il suffit de choisir un nom d'utilisateur, de spécifier son adresse email et de définir un mot de passe.

Ensuite il faut trouver le dépôt (repository) qui porte le nom data.emunova.net. Il suffit d'utiliser le système de recherche.

Pour rappel, Github est un service d'hébergement de dépôt Git. Ce dernier fait de la gestion de version sur du code (ou du texte). Ça permet d'avoir un historique complet de chaque modification sur chaque fichier. Dans le cas d'EmuNova le dépôt (data.emunova.net) sert à stocker toutes les données du site et uniquement les données. Il existe un autre dépôt contenant le code de génération du site qui ne nous intéresse pas ici. Par ailleurs, Github propose sur son portail (le site web github.com) des outils permettant de travailler directement en ligne et notamment faire de l'édition des données.

Le dépôt data.emunova.net présente une arborescence assez simple.

On peut voir les dossiers 'systems' et 'genres' qui contiennent des informations sur les différents supports de jeux et genres de jeux.

Le dossier intéressant est 'games'. Il contient la liste des consoles/ordinateurs. Chacun d'eux regroupent la liste des jeux dont le test est disponible.

Le dossier de chaque jeu comprend trois sous dossiers et un fichier.

Le fichier 'index.json' contient des informations sur le jeu. Le dossier 'images' rassemble les images affichées sur la fiche du titre. 'reviews' stocke les différents tests sous le format 'nom.md'. 'ratings' sert quand à lui pour les commentaires avec le même format 'nom.md'.

Bien entendu, tous les jeux ne possèdent pas de dossier. Voir certains possèdent un dossier à leur nom mais ne présente pas forcément de sous-dossier 'ratings' ou 'reviews', voir 'images'. La création d'un test ou d'un commentaire peut donc passer par la mise en place complète du morceau d'arborescence adéquate.

II. Les commentaires : modification.

(Là ça va, c'est simple.)

Pour commencer simple, nous allons modifier un commentaire existant. Tiens, par exemple mon commentaire de Double Dragon sur Amstrad CPC.

Magnifique non ?

On se déplace dans le dossier Git qui va bien: data.emunova.net / games / amstrad-cpc / double-dragon / ratings

On peut y voir le fichier rouliass.md. On clique dessus pour voir apparaître le contenu. Puis il suffit d'utiliser l'icône en forme de crayon pour proposer une modification.

On tombe sur une fenêtre d'édition.

Après validation (gros bouton vert "Propose the change"), la modification est prise en compte, mais partiellement. On créé ce qu'on appelle un 'fork', une copie personnelle du dépôt contenant notre modification. Comme on peu le voir sur l'image suivante:

A ce moment, nous pouvons demander d'intégrer notre modification au dépôt principal en cliquant sur le bouton vert "Create Pull Request" une première fois, puis en validant une deuxième fois sur la page suivante (même bouton). On tombe ensuite sur la page récapitulative de notre demande. On peut y mettre des commentaires supplémentaires.

Il faut maintenant attendre deux étapes.

1. Un des membres de l'équipe doit valider notre demande d'intégration au dépôt principal.

2. Une fois l'intégration faite, le Boss doit regénérer le site web pour afficher nos modifications.

II. Les commentaires : création.

(Bon ok, accrochez-vous quand même un peu.)

Nous allons maintenant passer à l'étape de création d'un commentaire. Etape qui n'est guère plus compliquée.

Voyons voir. Je n'ai jamais commenté Sonic Adventure 2 sur Dreamcast. N'y ayant pas joué depuis facile 10 ans, j'avais dû décrété que j'attendrais d'y retoucher pour ne pas écrire à la va-vite. Et bien tant pis, pour la science, je vais ajouter un commentaire rageux.

Il faut commencer par revenir sur le dépôt "data.emunova.net", puis aller dans le dossier "/games/dreamcast/sonic-adventure-2/ratings/". Une fois au bon endroit, On peut voir une petite croix (un +) à la fin de l'indication de chemin. En cliquant dessus (il y a une info-bulle noire pour vous aider à bien repérer l'endroit) on demande l'édition d'une nouvelle page.

On arrive sur un page d'édition. Il y a plusieurs chose à remplir ici. Tout d'abord, il faut nommer notre nouveau fichier <login>.md, ici <login> = surnom sur Emunova. Moi, par exemple, j'ai mis "rouliass.md". Il faut passer le retour à la ligne du mode "no wrap" à "soft wrap", sinon on devient dingue. Ensuite, il faut écrire son commentaire dans la grande partie centrale. Puis pour finir, il faut entrer un titre succinct et un commentaire qui servira aux modérateurs. Puis on clique sur "Propose new file"

Voilà ce que ça donne:

On arrive ensuite sur un récapitulatif de notre demande. Comme précédemment, cette création de nouveau fichier se fait sur un 'fork', une copie du dépôt principal qui nous appartient. Il faut donc cliquer sur le bouton vert "Create pull request" pour demander l'intégration sur le dépôt principal.

Il ne faut pas oublier de confirmer en recliquant sur "Create pull request" dans la page suivante (qui est un récapitulatif).

On finit par arriver sur une dernière page résumant la demande en cours. Il est possible d'y ajouter d'autres commentaires.

Bien évidemment, ce n'est pa si simple, en réalité, votre commentaire doit ressembler à la chose suivante:

On peut y voir les en-têtes indispensables que vous devez écrire vous-même (y compris pour la date).

1. L'auteur du commentaire
2. La note allouée
3. La date de publication

Comme pour la modification, la création passe par les deux étapes:

1. Validation de l'intégration (merge) par un membre de l'équipe

2. Regénération du site par le Boss.

Et après, vous êtes heureux.

IV. Et pour les tests ?

(On prend les mêmes et on recommence.)

Pour les tests, ça marche exactement de la même façon. Vous avez juste besoin de changer le dossier "ratings" par le dossier "reviews".

Evidemment, ça, c'est pour le texte. Mais avant, il faut créer une nouvelle entrée pour un jeu. Voilà comment ça se passe. Je vais chercher à ajouter Thanatos, un bon vieux jeu des familles sur CPC. On se déplace donc dans "oncletom / data.emunova.net / games / amstrad-cpc". On clique sur la croix (+) pour faire un ajout et on écrit "thanatos/".

On constate que "thanatos/" disparait de la zone éditable pour s'intégrer au chemin et qu'une nouvelle zone éditable apparait. Ça peut surprendre. Dans la nouvelle zone éditable on va taper "index.json" qui est le fichier qui va contenir les informations du jeu.

Le contenu est simple: Le nom, la date de sortie, l'éditeur, le nombre de joueur et le style de jeu. Le tout est dans un format bien précis à reproduire à l'identique. Toujours selon la méthode précédente, il faut fournir un commentaire au fichier et cliquer sur le bouton vert "Propose new file". Puis demander une "Pull Request".

Plus qu'à attendre l'intégration dans le dépôt principal puis la mise à jour sur le site web.

Pas la peine d'attendre ces deux étapes pour commencer à écrire votre test, tout peut-être fait en parallèle et validé plus tard. Il faudra simplement penser à redemander les création du dossier du jeu (on peut le demande n fois, ce n'est pas un problème).

Bon par contre, pour ajouter une image, c'est une autre paie de manches. C'est impossile avec le site web Github. Il faudra forcément passer par un client Git classique pour travailler. Je ne vais pas m'étendre sur le sujet qui risque de sérieusement rallonger le tutoriel. Donc pour le moment, il n'est pas possible d'ajouter une image à un test.

V. Astuces diverses ?

(Et avariées.)

Ecrire en gras: **ce texte est en gras**

Ecrire en italique: *ce texte est en italique*

Ecrire un titre: ## Ceci est un titre

Et bien d'autres à venir.

Modifié le 11 juin 2015 par Rouliass

[Spoz]

Très bonne initiative !

Que j'avais commencée il y a presque un an, mais j'avais laissé tombé dès les premières étapes parce que j'avais déjà un problème avec mon pseudo de testeur lambda qui n'arrivait pas à se rendre dans les dossiers EN dans Github.

Bref, je lirai tes modifications avec attention, ayant à l'époque eu quelques retours de Jedi sur ce que je faisais mal ou ne comprenais pas super bien.

Tu as tout mon soutien.

[Cyrilette]

C'est dommage qu'il n'y ait plus de statistiques, liste des tests par membres etc.

J'aimais bien voir le nombre de tests grimper, la course aux 4000 tests...nostalgie nostalgie.

C'était une bonne idée la tentative de refonte avec le système des contributions, mais c'est vraiment compliqué de redynamiser Emu Nova, avec l'évolution d'internet. Je crois que le site a fait son temps.

[Rouliass]

C'était une bonne idée la tentative de refonte avec le système des contributions, mais c'est vraiment compliqué de redynamiser Emu Nova, avec l'évolution d'internet. Je crois que le site a fait son temps.

Oui, c'est possible.

Je vais quand même tenter de contacter le taulier directement sur son adresse mail plutôt que par la messagerie interne du forum.

[Spoz]

Ca marche mieux en effet. En général.

[Rouliass]

Salut,

Ça sent le roussi quand même cette histoire.

[Spoz]

Il nous manque toujours et encore l'emoticon qui pleure à chaudes larmes.

Ah j'y pense, la dernière fois je l'avais fait revenir en soumettant une modification de test sur github. Tu peux tenter de rajouter une virgule quelque part pour voir.

Autre solution : FROMAGE!!!

Ou alors, puisqu'il me semble que, essayons : CHEESE!!!

[Rouliass]

Ah j'y pense, la dernière fois je l'avais fait revenir en soumettant une modification de test sur github. Tu peux tenter de rajouter une virgule quelque part pour voir.

J'ai déjà fait des modifications sur Github. C'est justement là que se trouvent mes interrogations.

[Spoz]

Tu les as validées, c'est à dire envoyées pour qu'elles soient acceptées ?

Anté> Tu peux les voir ?

[Antekrist]

Nope, dans la liste des requêtes tirées (bah je suis le fils caché de Jacques Toubon) j'ai que deux vieux tromblons dont un de toi.

Edit : par contre je viens de m'apercevoir que j'avais soumis un test (Fireland sur CPC) il y a un an histoire de voir comment ça fonctionnait et Jedi l'a balancé tel quel alors que j'ai encore plein de trucs à corriger et à vérifier.

Re-Edit : après vérif, j'ai aucune modif plus récente que huit mois dans le dossier games

Re-Edit 2, le retour : le commentaire que Rouliass a pris en test affiche toujours "un maniabilité".

[Rouliass]

j'ai 'commité' une modification sur le dépôt si c'est ce que tu veux dire. Ou alors tu veux parler de faire un 'pull request' ?

[Rouliass]

Ah bah voilà, je pense que j'ai la réponse à une partie de mes questions.

J'ai fait un 'commit' à partir du dépôt master. Ce qui a créé mon dépôt personnel (fork du master).

Seul des utilisateurs avec des droits d'accès en écriture sur le master peuvent valider les 'commit' en faisant un 'merge' des deux branches via un 'pull request' (que je n'avais pas fait donc).

[Antekrist]

Ouaip. Là c'est bon, j'ai mêlé (Toubon encore). Attendons de voir si ça fera réagir Maître Fromage.

[Rouliass]

Ça va déjà me permettre de poursuivre pas mal mon tuto.

[Spoz]

Oui désolé, j'ai pas eu le temps de fouiller dans mes archives. Ca viendra dès que possible.

[Rouliass]

Bon voilà, j'ai bien détaillé tout le processus pour modifier ou créer un commentaire sur un jeu. Pour créer ou modifier un test, ça fonctionne de la même façon. Il suffit de changer le chemin. "ratings" devient "reviews".

Ah oui, par contre, j'ai explosé mon quota de stockage. Il va falloir que je remanie mes images pour les rendre plus light.

Edit: fausse alerte, je viens de voir que j'ai oublié certains trucs

Modifié le 9 juin 2015 par Rouliass

[Spoz]

Tant que tu y es, oublie pas de rajouter les infos que je t'avais données pour transformer du texte en titre ou mettre du gras et de l'italique.

Et j'ai bon si je dis que tu est comme moi au niveau de l'ajout de photos, c'est à dire que tu ne comprends pas non plus comment ça fonctionne ?? ;-)

[Rouliass]

Bon voilà une version pseudo définitive. Je ne l'ai pas complètement relue, donc il y a sûrement des coquilles. Je ferai une grosse relecture un peu plus tard.

Pour le moment, je ne parle pas des images sur les tests tout simplement parce que Github ne permet pas d'en uploader. Du moins ce que j'ai pu comprendre.

Bon, je ne suis pas sûr de l'utilité de tout ça dans la mesure ou la mise à jour du site (et donc l'application de nos modifications dans Git) implique un jet de dés de la part du Boss et qu'il semble avoir un peu disparu. J'ai quand même fait l'effort de fournir un tuto à peu près correct eu égard au travail fourni par Jedi il y a un an. Il arrive sûrement un peu tard. Mais peut-être que cela n'aurait rien changé, comme le dit Cyrilette, il était peut-être compliqué, voir impossible de redynamiser EN. Enfin on va voir.

[Cyrilette]

Sympa de t'être autant décarcasser pour le tuto, même si j'avoue très subjectivement que sans se plonger dedans j'ai une impression de "fichtre ça a l'air compliqué tout ça". Mais comme en plus tu as pris un de mes tests comme modèle pour modifier un commentaire, je vais tâcher de me pencher dessus.

J'ai enfin fini Devil May Cry, Resident Evil Code Veronica et bientôt Silent Hill 4, faut que je consigne tout ça.

[Rouliass]

Je pense que c'est légèrement plus compliqué qu'avant, au départ. Mais une fois qu'on a bien compris l'organisation, ça devient facile.

[Puda]

Excuse, ton tuto est où ? Faut que j'écrive mon test.

Edit: J'ai suivi ton tuto. Bon j'avoue c'est pas mega fastoche mais bon. Et je ne vois pas du tout où et comment écrire mon test par contre ! Il faudrait ajouter cette partie dans le tuto.

Modifié le 16 juin 2015 par Puda

[Rouliass]

Je viens de voir que tu avais ajouté "games/pc/The-Cat-Lady/index.json". Pour créer ton test maintenant, tu dois créer "games/pc/The-Cat-Lday/reviews/puda.md avec comme en-tête:

---user: Pudarating: <ta note: 0 ou 1.5 ou 5 ou 2, etc ...>published: 2015-06-17T12:00:00.000Z---

<ton test ici>

[Puda]

Humm ok par contre quand je cherche The Cat Lady dans Games, je ne le trouve pas. Donc je vois pas comment créer "games/pc/The-Cat-Lday/reviews/puda.md"

Pour le test je le mets entre < > ?

[Rouliass]

Non, pas de <>. Tu mets:

rating: 3.5

Pour créer le fichier "review/puda.html", tant que ta demande de création de The-Cat-Lady/index.json n'est pas validé et intégré (mergé), tu dois recréer le dossier pour toute nouvelle création de fichier.

[Puda]

Dans ce cas, tu peux merger ? Ca sera quand même plus simple.