[Galette-devel] Documentation de dév : mise à jour
Salut, J'ai mis à jour la doc en ligne, avec quelques petites modifications en ce qui concerne le développement. La liste des changements est là : http://git.tuxfamily.org/galette/galettedoc?p=galette/galettedoc.git;a=commitdiff;h=fdc3e716c05934a427e9207e46ac3eb33c9b511e La doc est là : http://galette.tuxfamily.org/documentation/fr/development/index.html ++ -- Johan signature.asc Description: OpenPGP digital signature ___ Galette-devel mailing list Galette-devel@gna.org https://mail.gna.org/listinfo/galette-devel
[Galette-devel] Documentation de développement
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Salut, J'ai mis en ligne dans la documentation de développement une page qui contient des informations utiles pour le développement : http://galette.tuxfamily.org/documentation/fr/development/contributor.html Ce n'est pas complet, ce sera étoffé avec le temps - de même que la page sur la récupération des sources http://galette.tuxfamily.org/documentation/fr/development/git.html - mais cela devrait constituer un début raisonnablement suffisant pour commencer ;) L'un des avantages de Git est qu'il est possible simplement de fournir des patchs correctifs ou évolutifs à intégrer dans le code de Galette. Vous pouvez travailler sur un projet versionné (avec tous les avantages que ça apporte - si, si, je vous assure :p) de votre côté, pour transmettre ensuite la série de modifications (sous forme de patchs) que vous avez apportée. D'un autre côté, quelqu'un récupère ces patchs, les applique dans une branche locale, teste, corrige éventuellement (ou vous demande de corriger, en fonction de la nature et de la gravité du problème), ... À un moment du processus, le code pourra être intégré à Galette (pour le moment, il n'y a que moi qui m'occupe de cette étape ; pour laquelle le workflow doit être respecté, etc). Les patchs peuvent être transmis via le bugtracker (http://redmine.ulysses.fr) ; ou par mail/liste de diffusion (si toutefois « ça ne pèse pas un âne mort »... ;-) ). Un mot sur Git, qui peut sembler un gros mot, voire une bête effrayante :-D En toute honnêteté, ce n'est pas si compliqué à utiliser. Notons deux aspects : le mode de fonctionnement, et le « degré d'utilisation » de l'outil : * le mode de fonctionnement est très différent de ce que beaucoup connaissent pour avoir utilisé CVS et/ou SVN (ce qui est mon cas), * Git offre beaucoup de possibilités, que vous n'êtes absolument pas obligé d'utiliser. Évidemment, le nombre de commandes et d'options possibles n'étant pas compressibles, c'est un peu impressionnant au départ, mais pour simplement corriger un petit bogue ou implémenter quelque chose dans Galette, de votre côté, très peu d'entre elles sont requises, ce seront juste une poignée de commandes qui vont se répéter dans la plupart des cas. Plusieurs interfaces graphiques sont disponibles pour Git, que ce soit pour Linux, Windows, ou Mac. N'ayant pas de mac, je ne les connais pas, ne peux les tester ni les documenter. Pour windows, j'ai essayé plus tôt d'installer GitExtensions dans une machine virtuelle, ça n'est pas passé (j'ai pourtant plusieurs collègues qui l'utilisent au quotidien et je l'ai installé avec succès sur d'autres postes) :-/ Les contributions pour documenter les outils graphiques sont les bienvenues, je n'utilise pour ma part que gitg sous Linux. Si vous avez des questions/problèmes/remarques ; n'hésitez pas à demander, soit ici, soit sur le canal irc de Galette :) Quelques liens utiles sur Git : - - astuces et commandes de base : http://www-cs-students.stanford.edu/~blynn/gitmagic/intl/fr/ch02.html - - pour s'y retrouver quand on vient de SVN : http://git-scm.com/course/svn.html - - s'y retrouver dans les différentes « couches » : ndpsoftware.com/git-cheatsheet.html Bon dimanche, - -- Johan -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAk9KG/UACgkQ7N2B+4uln5Q5CgCeLJC5QrcbPjKjODk1c+bMDpJd 73kAoL17BqXZiVI0cjb53n2cDufK1BW/ =lsKp -END PGP SIGNATURE- ___ Galette-devel mailing list Galette-devel@gna.org https://mail.gna.org/listinfo/galette-devel
Re: [Galette-devel] Documentation de développement
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Le 26/02/2012 12:48, Johan Cwiklinski a écrit : Salut, J'ai mis en ligne dans la documentation de développement une page qui contient des informations utiles pour le développement : http://galette.tuxfamily.org/documentation/fr/development/contributor.html Ce n'est pas complet, ce sera étoffé avec le temps - de même que la page sur la récupération des sources http://galette.tuxfamily.org/documentation/fr/development/git.html - mais cela devrait constituer un début raisonnablement suffisant pour commencer ;) Je me suis rendu compte que j'avais oublié de préciser le caractère non obligatoire de Git ici tout comme dans la documentation... C'est désormais chose faite :) ++ - -- Johan -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAk9KIykACgkQ7N2B+4uln5QDfQCeK5IV6UQK7A4vcNrC78UbaFok ndUAnjASs+Lh7Lz8Pg5COX15bvE5d3JC =yEcj -END PGP SIGNATURE- ___ Galette-devel mailing list Galette-devel@gna.org https://mail.gna.org/listinfo/galette-devel
Re: [Galette-devel] Documentation de développement
Le 26/02/12 13:18, Johan Cwiklinski a écrit : -BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Le 26/02/2012 12:48, Johan Cwiklinski a écrit : Salut, J'ai mis en ligne dans la documentation de développement une page qui contient des informations utiles pour le développement : http://galette.tuxfamily.org/documentation/fr/development/contributor.html Ce n'est pas complet, ce sera étoffé avec le temps - de même que la page sur la récupération des sources http://galette.tuxfamily.org/documentation/fr/development/git.html - mais cela devrait constituer un début raisonnablement suffisant pour commencer ;) Je me suis rendu compte que j'avais oublié de préciser le caractère non obligatoire de Git ici tout comme dans la documentation... C'est désormais chose faite :) Je tente depuis plusieurs jours de me servir de GIT sur MAC mais cela n'a rien d'évident et pour le moment je n'obtiens rien de bon; Il faut que je dise que par principe, je ne veux pas utiliser autre chose que du libre, qui est encore rare pour git/mac OS. Aparemment, il faut une version évoluée de mac (OS 11) je crois avoir compris. ++ - -- Johan -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAk9KIykACgkQ7N2B+4uln5QDfQCeK5IV6UQK7A4vcNrC78UbaFok ndUAnjASs+Lh7Lz8Pg5COX15bvE5d3JC =yEcj -END PGP SIGNATURE- ___ Galette-devel mailing list Galette-devel@gna.org https://mail.gna.org/listinfo/galette-devel ___ Galette-devel mailing list Galette-devel@gna.org https://mail.gna.org/listinfo/galette-devel
Re: [Galette-devel] Documentation de développement
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Le 26/02/2012 16:16, André Lefranc a écrit : Je tente depuis plusieurs jours de me servir de GIT sur MAC mais cela n'a rien d'évident et pour le moment je n'obtiens rien de bon; Il faut que je dise que par principe, je ne veux pas utiliser autre chose que du libre, qui est encore rare pour git/mac OS. Aparemment, il faut une version évoluée de mac (OS 11) je crois avoir compris. En regardant vite fait, j'ai trouvé 3 interfaces graphiques libres qui ne semblent pas avoir de pré-requis phénoménaux (mais bon, moi Mac, j'y connais rien) : * http://gitx.frim.nl/index.html * https://github.com/Caged/gitnub/wiki * http://gityapp.com/ Pour installer Git lui même : * http://book.git-scm.com/2_installing_git.html (ils traitent de « Mac 10.4 » et de « Mac 10.5 ». Hope that helps... ++ - -- Johan -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.18 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iEYEARECAAYFAk9KUnsACgkQ7N2B+4uln5THQACfbXyCtwfJ6OzR2SjitRy8d184 R1sAnid9EmK3NCP7qcYrpdgOi2uyGfjm =Vfjj -END PGP SIGNATURE- ___ Galette-devel mailing list Galette-devel@gna.org https://mail.gna.org/listinfo/galette-devel
[Galette-devel] Documentation de Galette
Bonjour, Galette dans sa version 0.63 est sortie depuis le 6 janvier 2009. Actuellement, la documentation est relativement loin d'être à jour Je n'ai pas vraiment le temps de m'atteler à cette tâche, je préfère de loin consacrer mon temps de travail au développement. Je souhaiterai donc un petit coup de pouce de votre part, gentils utilisateurs et développeurs, pour remettre un peu tout cela au goût du jour :-) D'avance merci, Johan signature.asc Description: OpenPGP digital signature ___ Galette-devel mailing list Galette-devel@gna.org https://mail.gna.org/listinfo/galette-devel
Re: [Galette-devel] Documentation
John Perr a écrit : Dans la dernière révision de l'arborescence de développement, il y a une tentative de création de documentation pour avis: -Documentation développeur: Elle utilise phpdocumentor utilisé par exemple par PEAR et est générée à partir de docblocs écrit dans le code. http://www.phpdoc.org/ Vous pouvez voir le résultats dans le répertoire docs/index.html. C'est encore loin d'être complet mais si cela plaît à cette liste alors on peut l'adopter. Dans ce cas, il y a quelques règles d'écriture à respecter et le plus simple serait probablement d'adopter celles de pear par exemple: http://pear.php.net/manual/fr/standards.php -Manuel utilisateur La c'est un plagia exhaustif du site de tuxfamilly/galette avec quelques petits ajouts concernant les préférences. Le résultat html est visible dans docs/manual/manual.html. On peut générer aussi du pdf à partir des sources en xml/docbook mais ça reste à faire, et il faut installer Fop sur la machine qui génère le manuel. Pour fabriquer du html il faut xsltproc. Il est théoriquement possible de fabriquer des pages pour un site web mais dans le cas de tuxfamily, il faudrait écrire ou (modifier beaucoup) un xsl qui produise un format compatible du wiki tuxfamily. Donc forget it... phpdocumentor à la possibilité d'intégrer la doc annexe mais comme ce n'était pas très convaincant, la création du manuel est restée indépendante de la doc développeur. Salut, Je n'ai pas encore eu le temps ( le courage? shame on me ;o) ) de regarder cela en profondeur, cependant j'ai une petite remarque : le cartouche de licence GPL a été supprimé dans les fichiers modifiés, il vaudrait mieux le laisser je pense, c'est ce que j'en comprend à la lecture de la page : http://www.gnu.org/licenses/gpl-howto.html. Ce n'est pas incompatible à mon sens avec la mise en place du système de documentation... Pour les conventions de codage, il me semble en effet utile et intéressant de reprendre celles de PEAR, pour ma part. Bon dimanche, Johan signature.asc Description: OpenPGP digital signature ___ Galette-devel mailing list Galette-devel@gna.org https://mail.gna.org/listinfo/galette-devel
[Galette-devel] Documentation
Dans la dernière révision de l'arborescence de développement, il y a une tentative de création de documentation pour avis: -Documentation développeur: Elle utilise phpdocumentor utilisé par exemple par PEAR et est générée à partir de docblocs écrit dans le code. http://www.phpdoc.org/ Vous pouvez voir le résultats dans le répertoire docs/index.html. C'est encore loin d'être complet mais si cela plaît à cette liste alors on peut l'adopter. Dans ce cas, il y a quelques règles d'écriture à respecter et le plus simple serait probablement d'adopter celles de pear par exemple: http://pear.php.net/manual/fr/standards.php -Manuel utilisateur La c'est un plagia exhaustif du site de tuxfamilly/galette avec quelques petits ajouts concernant les préférences. Le résultat html est visible dans docs/manual/manual.html. On peut générer aussi du pdf à partir des sources en xml/docbook mais ça reste à faire, et il faut installer Fop sur la machine qui génère le manuel. Pour fabriquer du html il faut xsltproc. Il est théoriquement possible de fabriquer des pages pour un site web mais dans le cas de tuxfamily, il faudrait écrire ou (modifier beaucoup) un xsl qui produise un format compatible du wiki tuxfamily. Donc forget it... phpdocumentor à la possibilité d'intégrer la doc annexe mais comme ce n'était pas très convaincant, la création du manuel est restée indépendante de la doc développeur. -- John Perr GPG Id 0xA83889EC ___ Galette-devel mailing list Galette-devel@gna.org https://mail.gna.org/listinfo/galette-devel
