1. Mathieu Leduc-Hamel
  2. djangofr

Wiki

Clone wiki

djangofr / Home

Traduction de la documentation

(Ce texte d'explication vient du repos de djangofr)

Comment participer ?

Si vous voulez participer à la traduction française de la documentation de Django ou à sa relecture, veuillez suivre les étapes suivantes :

Installez les programmes nécessaires :

  • un client subversion pour récupérer la doc du trunk django (la VO)
  • un client mercurial pour récupérer la doc VF et commiter vos traductions les docutils Python et sphinx pour vérifier que vos traductions sont valides (compilables).
  • Choisissez un fichier à traduire : prenez de préférence un fichier non traduit, ou actuellement sans mainteneur. * Certaines documentations sont plus urgentes que d'autres à réaliser/mettre à jour : toute l'introduction (répertoire intro/ dans la VO), et les docs de référence de base (/ref dans la VO) sont plus importants que /ref/contrib/ ou /obsolete par exemple.
  • Si le fichier choisi a un mainteneur, mais qu'il est très vieux (le fichier, ahem), tentez de le contacter par mail ou sur #django-fr sur freenode pour demander de reprendre la responsabilité de cette documentation.
  • Créez-vous un compte Bitbucket et demandez de vous ajouter en tant que contributeur (Mathieu Leduc-Hamel <marrakis@gmail.com> ou arrakis sur #django-mp sur freenode). Utilisez de préférence votre nick freenode comme login bitbucket, c'est plus facile à suivre :)
  • Récupérez la documentation originale (voir ci-dessous)
  • Récupérez le dépôt français (voir ci-dessous). Attention le répertoire docs/ contient la nouvelle arborescence de la documentation, l'ancienne est dans olddocs/
  • Mettez à jour cette page pour indiquer votre intention de traduire
  • Traduisez en vous aidant des traductions existantes pour le vocabulaire/style
  • Vérifiez que votre traduction est valide docutils/sphinx en "compilant" celle-ci vers du html
  • Commitez vos traductions sur le dépôt français, en indiquant impérativement le numéro de version svn de l'original que vous avez traduit dans le message de commit
  • Mettez à jour cette page en indiquant que ce fichier est traduit, avec la version
  • Anciens mainteneurs, une table pour vous permettre de retrouver la traduction dont vous avez la charge dans la nouvelle arborescence de la documentation du trunk est en cours d'élaboration : OldNewDocTable

Interactions avec le dépôt original (subversion, django trunk)

Pour récupérer les fichiers, il faut atteindre le dépôt subversion du projet Django :

svn co http://code.djangoproject.com/svn/django/trunk/docs/ django-docs Pour remettre tous les fichiers à jour, lancez :

svn up Pour connaître la version d'un fichier donné :

svn info intro/tutorial01.txt Pour savoir ce qui a changé depuis votre dernière traduction :

svn diff -r7777 intro/tutorial.txt avec 7777 la révision de votre dernière traduction.

Interactions avec le dépôt français (bitbucket/mercurial)

Pour récupérer les sources du site :

$ hg clone http://bitbucket.org/mlhamel/djangofr/ Vous allez ensuite pouvoir effectuer des modifications locales, lorsque vous êtes satisfait il suffit de faire :

$ hg ci -m "Message de commit" Cela va ajouter une révision locale, il est nécessaire d'envoyer ces modifications au dépôt afin qu'elles soient accessibles à tous :

$ hg push Si des modifications ont été réalisées par d'autres personnes, vous allez pouvoir les récupérer localement :

$ hg pull Mais pour qu'elles soient appliquées à vos fichiers locaux, il vous faudra les mettre à jour :

$ hg up

Updated