Mis à jour Doc

[cru...@free.fr]

Bonjour,

En quoi puis je être utile, j'ai vu effectivement des différences entre la 2.1 anglaise et la 2.1 Fr, je me posais la question de comment contribuer.

J'allais poser la question Chez SensioLabs, j'y suis le 10 et 11 pour un formation.

A votre disposition.

Cordialement

Stéphan

Compte Tweeter et Github  : Stef Tweet

[Greg Quat]

Salut,

En fait nous n'avons pas grand chose à voir avec Sensio (à part qu'on bosse sur la traduction de sf2 bien sûr)...

Je t'explique le "problème" : la documentation anglaise (2.0, 2.1, master) évolue assez rapidement car il y a énormément de contributeurs qui y apportent des corrections et des évolutions. Elle est principalement gérée par Ryan Weaver dont le travail consiste essentiellement à accepter et merger les Pull Request des contributeurs (je suppose que tu maitrises Git, sinon il va falloir apprendre avant de faire quoi que ce soit). Donc même s'il y a beaucoup de travail, Ryan arrive à tenir le rythme.

Nous, nous ne pouvons pas récupérer directement les PR des contributeurs anglais. Car même si nos traductions proviennent à la base des sources anglaises, elles doivent être considérées comme des documents nouveaux (git ne peut pas merger une modif anglaise dans un document en francais, pour lui, tout le fichier est différent).

Donc notre boulot consiste à parcourir les derniers changements de la doc anglaise à la main, et de répercuter les modifications dans nos fichiers une par une. Ce qui représente un gros boulot. Nous avons essayé de trouver une meilleure solution mais il ne semble pas y en avoir.

Avec l'augmentation des contributeurs anglais et mon nouveau travail, j'ai du mal à trouver le temps de les mettre à jour. Thomas Botton, qui travaillait avec moi est également très occupé par sa nouvelle vie de famille donc nous avons accumulé 2 mois de retard.

L'idée est de trouver une troisième personne, ou même plus, qui pourrait nous aider à rattraper le retard accumulé et à garder la doc à jour. C'est un souhait qu'on a avec Thomas : faire des mises à jour plus souvent (comme c'est un long travail, avant j'en faisais toutes les 2 semaines et j'y passais tout mon samedi. L'idée est de les faire plus souvent pour avoir moins de travail mais pour l'instant nous n'arrivons pas à honorer cette promesse).

Donc en résumé, il faut maitriser git (pas forcément besoin de connaitre par coeur, ce n'est pas mon cas), être très rigoureux car cela demande de l'organisation et de la patience, et évidemment être très bon en français et en anglais (si c'est pour faire plein de fautes, ce qui nous obligerait à repasser derrière, ce n'est pas la peine).

Enfin, je préfère que tu me dises maintenant "je ne me sens pas de le faire" plutôt que bacler le travail ou nous lacher en plein milieu. Si tu as du temps en ce moment, et qu'ensuite tu risques d'en avoir moins, dis le. Tu pourras peut être nous aider au moins à rattraper un peu de retard.

La première étape consiste à forker le dépot https://github.com/symfony-fr/symfony-docs-fr sur ton compte.

Nous avons un wiki qui dit où nous en sommes. https://github.com/symfony-fr/symfony-docs-fr/wiki/Suivi-du-travail-en-cours

L'idée est donc de parcourir tout les commits intégrés sur les 2 branches depuis la date indiquée dans le wiki.

Nous n'avons pas de branche 2.0 (elle n'est pas traduite). Donc la "meilleure" méthode que j'ai trouvée consiste à parcourir les commits de la master, faire les modifs correspondantes dans un dépot, et en parallèle parcourir les commits de la 2.1 et faire les modifs dans un autre dépot.

Puisque la plupart des modifs sont identiques entre les 2 branches, la plupart du temps du feras un copier/coller de ta traduction de la master vers la 2.1.

Voilà, dis moi si tu te sens d'attaque, ce que t'en penses, et si tu le sens bien, on fera un essai sur quelques commits. Je me suis arreté au 9 novembre donc tu pourras commencer jusqu'au 13 novembre pour essayer.

En tout cas déjà merci pour la proposition, et si tu veux contribuer sans y passer tant de temps, il y a toujours des corrections à faire (erreurs de frappe, fautes de grammaire, traductions à améliorer, etc...) Dans ce cas, même principe, tu forkes le dépot, tu corriges, et tu fais une pull request.

Greg

--
Vous recevez ce message, car vous êtes abonné au groupe Google Groupes symfony-docs-fr.
Pour envoyer un message à ce groupe, adressez un e-mail à symfony...@googlegroups.com.
Pour vous désabonner de ce groupe, envoyez un e-mail à l'adresse symfony-docs-...@googlegroups.com.
Pour plus d'options, consultez la page de ce groupe : http://groups.google.com/group/symfony-docs-fr?hl=fr

[Stef Tweet]

Bonjour,

J'ai déjà forké le projet. sur mon compte Github.

Est ce le tableau de suivi doit être rempli ? comment cela fonctionne ?

J'utilise Netbeans pour mes projets dev, qu'utilise tu comme outils pour la documentation ?

Je vais regarder les commits de la doc anglaise (effectivement y a du retard :) )

[Greg Quat]

Salut,

Le tableau est déjà à jour. On s'en servait surtout quand les traductions n'étaient pas finies. Ce qui est important c'est de garder à jour le numéro et la date du dernier commit anglais traité pour chaque branche.

Moi j'utilise sublime text pour travailler mais tu peux utiliser ce que tu veux. Fait un essai sur 3 ou 4 jours que je vois si ta méthode de travail convient. J'essaierai également de travailler dessus cette semaine.

Cette discussion peut être lue sur le Web à l'adresse https://groups.google.com/d/msg/symfony-docs-fr/-/TZXIMh2IKF8J.

[stéphan Plu]

Bonsoir,

Je vais être un peu pris cette semaine, mais je commence à regarder comment tout ça fonctionne.

Juste pour comprendre, je suis tombé sur ce commit https://github.com/symfony/symfony-docs/commit/8e53c1651c76d9e9096d6875269596846519c94a

Est ce normal que ce fichier ne soit pas présent encore dans le dépôt ?

Vu que sur le principe on est au 09 novembre.

[Greg Quat]

En fait avant de commencer à mettre à jour, je compare les fichiers présents sur nos branches avec ceux présents sur les branches anglaises. Ca permet de rien oublier une fois la MAJ finie.

Là, le problème vient en partie de git, si le mec fait sa modif le 2/11 et fait sa PR le même jour, moi je passe le 9/11 mais il n'y a rien car Ryan n'a pas encore accepté la PR. S'il accepte la PR le 11/11 par exemple, la modification est bien datée du 2/11, mais je suis passé à coté.

Pour éviter cela, je fais une vérification rapide des 10 derniers jours (en gros, si je me suis arrété au 9/11, je vérifie que j'ai bien toutes les modifs entre le 31/10 et le 9/11). Tu verras de toute manière que la plupart des commits faits par Ryan sont des merges ou des modifs de commits. En gros, ils servent à vérifier qu'on n'oublie rien.

En général, en suivant la liste, tu intègres 3 ou 4 commits de contributeurs, et ensuite tu as les merge de Ryan qui les reprennent, et ainsi de suite.

Je vais essayer d'arriver jusqu'au 26 ou 27 novembre et te laisser les derniers jours de novembre. Comme ça ça t'évitera le travail fastidieux de reprendre là ou j'en étais. 

En tout cas c'est bien que tu aies posé cette question, ça veut dire que tu as pigé le truc :)

[Greg Quat]

Salut,

J'ai repris ce qu'il manquait et je me suis arreté au 10 novembre (qui n'est pas fait). Je risque de continuer cet aprem ou demain si j'ai un peu de temps donc je te tiendrai au courant.

Concernant le document twig_reference.rst, je l'ai mis à jour dans sa version d'aujourd'hui. Donc c'est normal si toutes les modifs de ce doc sont déjà prises en compte.

Je commit tout ça tout de suite donc si tu t'y mets, il faut reprendre les commits anglais à partir du 10 novembre inclus. Attention de bien traiter chaque branche séparément.

[skeud]

Salut,

Il se peut que j'ai du temps dans la semaine prochaine sur mes heures de boulot.

Afin qu'on fasse pas du boulot 2 fois, est-ce que tout le monde fait comme Greg à savoir laisser un message ici pour prévenir s'il bosse sur les traductions ?

Bon week-end à tous

[stéphan Plu]

Salut,

J'attendais de tes nouvelles m'y mettre sérieusement.

Comment fait tu pour comparer les deux branches ? tu ouvres github dans deux onglets pointant chacun sur une branche ?

Pour les modifications, tu fait chaque branche à chaque fois je suppose, même si la modif est la même.

[stéphan Plu]

Une tit question, comment fait on pour avoir une comparaison des branches entre deux commits. Quand je clique sur le lien du wiki, je ne vois pas le commit ou tu en es car il y a plus de 250 commits.

J'ai essayé dans l'url de mettre les sha deux chaques coté ... marche pas non plus.

[Greg Quat]

La comparaison entre 2 branches n'est pas vraiment pertinente tant il y a de différences.

Sinon oui, j'ouvre les 2 branches dans 2 onglets, j'ai 2 éditeurs de texte et voilà :)

La plupart des commits sont communs aux 2 donc il s'agit de faire le travail une fois et de le copier/coller. Mais des fois il y a du spécifique à la master, faut pas s'embrouiller.

Là je suis en train de faire le 10/11 donc vous pourrez reprendre à partir du 11/11 une fois que j'aurai pushé (d'ici 1h).

Concentre toi sur 2 ou 3 jours pour commencer.

[stéphan Plu]

Salut, je suis sur le 11 et le 12 novembre.

Je tombes sur une tuile.

Un nouveau fichier est disponible un helper console.

Le répertoire helpers fr est disponible pour la branch master mais pas pour la branche 2.1.

Faut il la créer ?

[stéphan Plu]

Désolé, j'ai fait mon premier pull request sur la master, je l'ai refait après sur la 2.1.

Juste une chose que je n'ai pas bien vu, c'est pour faire des liens internes dans le doc. Est ce que tu peux corriger le doc

formatterhelper.rst, les liens sont vers source anglaise.

[stéphan Plu]

Dernier jour traité master et 2.1 13/12/2012 pull request en cours....

[stéphan Plu]

J'arretes les pull request pour que tu me dises de quoi vers quoi je dois pull parce que quand je vois le pull request de master vers 2.1 c'est pire et je pense que c'est normal.

[Greg Quat]

Je regarde ça ce soir

[Greg Quat]

Re,

En fait le répertoire "helper" existe bien sur la 2.1, je l'ai créé ce matin (https://github.com/symfony-fr/symfony-docs-fr/tree/2.1/components/console/helpers)

Du coup, soit tu as parlé un peu vite et je suppose que tu l'as trouvé après, soit tu as fait une erreur en récupérant la branche 2.1 en local.

J'ai fait quelques commentaires sur ce que tu as fait. Sur la master c'est presque bon, j'ai juste l'impression qu'il manque des trucs. Sur la 2.1, à mon avis il y a un problème donc j'ai préféré refusé. Vaut mieux que tu vérifies que tu as bien récupéré la branche 2.1. Perso, je préfère avoir les branches en local, faire le boulot 2 fois et pas me gourer, que travailler avec une seule  branche et faire des conneries (je maitrise pas assez git pour me lancer là dedans)

Voici, de mémoire, comment j'ai procédé:

- J'ai créé 2 répertoires, un "master", un autre "2.1"

- Dans chacun de ces répertoires, j'ai fait un git clone du projet gregquat/symfony-docs-fr (mon fork de symfony-fr/symfony-docs-fr)

- Je me retrouve avec quelque chose du type "master/symfony-docs-fr/*" et" 2.1/symfony-docs-fr/*"

- Dans master, je crée une branche master basée sur la branche master de gregquat/symfony-docs-fr : git checkout -b master origin/master

- Idem dans le dossier 2.1 : git checkout -b 2.1 origin/2.1

- Avec "git branch", je regarde que dans chacun des répertoires, j'ai la bonne branche (idéalement, on enlève les autres branches)

- Vérifier qu'on a les bonnes sources pour chacune des branches (ex, le fichier symfony-docs-fr/index.rst, la partie "CMF" ne doit être présente que sur la master) https://github.com/symfony-fr/symfony-docs-fr/blob/master/index.rst

- Du coup, tu peux applique les modifs de la master, sur ta branche master et idem sur la branche 2.1. Quand tu pusheras, normalement ça ira sur la bonne branche (vérifie bien, par exemple en mettant des commentaires différents sur la branche 2.1, même si les modifs sont les mêmes que la master).

- Quand tu feras ta PR, vérifie bien de faire master->symfony-fr/master et 2.1->symfony-fr/2.1

ATTENTION!

Avant de commencer à bosser, il faut systématique reprendre les modifs de symfony-fr/symfony-docs-fr (un pull ne reprendra les modifs que de ta branche distance, pas celles de la branche de symfony-fr).

Pour cela, il faut pour chacun de tes dossiers/branches :

- Définir une nouvelle "source" avec  git remote add NOMBRANCHE https://github.com/symfony-fr/symfony-docs-fr.git

- Récupérer les modifs de symfony-fr/symfony-docs-fr avec git fetch upstream (cela crée des branches temporaires)

- Merger ces branches temporaires dans tes branches de travail avec git merge NOMBRANCHE/master (cela suppose que tu es déjà sur la branche master) ou git merge NOMBRANCHE/2.1 (si t'es sur la branche 2.1)

Voilà, tu sais peut être déjà tout ça, il y a peut être/surement une meilleure méthode de travail, j'ai fait ce "tuto" de mémoire donc il y a peut être des erreurs, mais voilà l'idée.

JE reste à ta dispo, tu peux me contacter par gtalk si besoin.

Bon courage

[stéphan Plu]

Ok la je vais retourner ma vrai vie, je regardes plus tard mais j'ai compris.

Par contre les modifications, je l'ai faire directement dans mon github.

Est ce que tu penses qu'il failles que je repartes à 0 ? ou juste à reprendre les modifs pour la 2.1

[Greg Quat]

La master tu peux annuler ta PR, faire les quelques modifs qui manquent (soit en local, puis push, puis PR) soit sur github puis PR. En fait les modifs en elles-mêmes c'est pas grave, je pourrais les faire. Je veux juste comprendre pourquoi elles sont manquantes (pas vu le second fichier, fait un peu vite, ...).

Et la 2.1 oui, malheureusement faudrait recommencer avec une bonne méthode ;).

Mais t'en fait pas, t'as le temps. On sait que le 11 et 12 novembres ont été fait ou seront faits par toi, si je continue je reprendrai à partir du 13.

Dans tout les cas, merci déjà pour le temps passé!

A bientôt.

Greg

[stéphan Plu]

Je ne peux pas annuler mon pull request, close le, je le réémettrais avec plus de précision. Merci pour ta patience.

[skeud]

Je suis en train de m'occuper des commits du 13 novembre sur master si jamais (uniquement 2 commits).

[stéphan Plu]

J'ai traité déja le 13 novembre prochain jour à traiter le 14 novembre

Cette discussion peut être lue sur le Web à l'adresse https://groups.google.com/d/msg/symfony-docs-fr/-/dcjKPGPUulwJ.

[stéphan Plu]

d'ailleurs tu en vois deux ?

Moi je ne vois que celui la commit

7069e85f9dba50db0a616ebfcbcfaab637379b93
Author: David Buchmann <da...@liip.ch>
Date:   Tue Nov 13 09:02:45 2012 +0100

[stéphan Plu]

Est ce que quelqu'un peux m'expliquer ce commit.

Quand je fais un git log --after 2012/11/13 --before 2012/11/14 j'ai un commit du 5 novembre 9d73c61efea77492eac75d2eb2ee79b86d675428 ? et j'ai l'impression qu'il a déja été traduit

[skeud]

Argh je viens de faire le 13 novembre et d'accepter la PR

Les deux commit fait sur master sont visibles ici:

* https://github.com/symfony/symfony-docs/commits/master?page=15

@greg: tu te bases sur le git log ou bien sur l'historique des commits dans github?