CakePHP est un framework PHP simple, puissant et très populaire... sauf en France où il reste injustement méconnu.
Le CookBook, documentation en ligne de CakePHP, existe en anglais, français, espagnol, portugais et japonais. Il est à jour et agréable à lire.
Et moi ?
Je suis un utilisateur francophone de CakePHP.
Ce dépôt est un fork de la documentation officielle, et a pour but de proposer à au dépôt officiel des mises à jour régulières de la traduction française du CookBook. C'est un travail constant, car le projet est dynamique et a documentation... aussi !
Votre mission (si toutefois vous l'acceptez)
Actuellement, CakePHP est dans sa version majeure 4.x. Or bon nombre d'articles de la doc française n'ont pas été mis à jour depuis la version 3 : il y a du boulot !
Actuellement, je travaille sur la traduction des dernières évolutions de la doc 4.x (version en ligne) et 4.next (version mineure à venir). Je prends le temps de relire et rectifier les traductions de certains chapitres entiers, mais seul je ne vais pas bien loin.
Est-ce compliqué ?
Un enfant pourrait le faire !
La version officielle (en anglais) se trouve sous le répertoire en. La traduction française se trouve dans le répertoire fr, et chaque fichier français doit correspondre à son équivalent anglais.
Les fichiers sont des fichiers texte tout simples, avec quelques indications de mise en forme.
Pour faire un travail efficace, vous aurez besoin de Git. C'est tout.
Personnellement, j'écrase un fichier anglophone par son équivalent francophone, et un git diff me montre les différences de traduction. Les besoins de mise à jour sautent aux yeux à la simple lecture.
Pour quoi faire ?
Question
Qu'est-ce qui est pire, pour une application informatique, que de ne pas avoir de documentation du tout ?
Réponse
Avoir une documentation obsolète...
En traduisant CakePHP, vous contribuez à la popularité dans les pays francophones d'un framework accessible à tous.
Quand une de vos pull requests est acceptée par le dépôt officiel, la doc est déployée en ligne directement : vous voyez immédiatement le fruit de votre travail.
Pour commencer
Les fichiers suivants nécessitent une relecture complète. Certains n'ont même jamais été traduits et sont restés en anglais.
La liste n'est pas exhaustive.
CakePHP, kézako ?
CakePHP est un framework PHP simple, puissant et très populaire... sauf en France où il reste injustement méconnu.
Le CookBook, documentation en ligne de CakePHP, existe en anglais, français, espagnol, portugais et japonais. Il est à jour et agréable à lire.
Et moi ?
Je suis un utilisateur francophone de CakePHP. Ce dépôt est un fork de la documentation officielle, et a pour but de proposer à au dépôt officiel des mises à jour régulières de la traduction française du CookBook. C'est un travail constant, car le projet est dynamique et a documentation... aussi !
Votre mission (si toutefois vous l'acceptez)
Actuellement, CakePHP est dans sa version majeure 4.x. Or bon nombre d'articles de la doc française n'ont pas été mis à jour depuis la version 3 : il y a du boulot ! Actuellement, je travaille sur la traduction des dernières évolutions de la doc 4.x (version en ligne) et 4.next (version mineure à venir). Je prends le temps de relire et rectifier les traductions de certains chapitres entiers, mais seul je ne vais pas bien loin.
Est-ce compliqué ?
Un enfant pourrait le faire !
La version officielle (en anglais) se trouve sous le répertoire
en
. La traduction française se trouve dans le répertoirefr
, et chaque fichier français doit correspondre à son équivalent anglais. Les fichiers sont des fichiers texte tout simples, avec quelques indications de mise en forme.Consultez les consignes adressées aux contributeurs de la documentation officielle.
Outils nécessaires
Pour faire un travail efficace, vous aurez besoin de Git. C'est tout. Personnellement, j'écrase un fichier anglophone par son équivalent francophone, et un
git diff
me montre les différences de traduction. Les besoins de mise à jour sautent aux yeux à la simple lecture.Pour quoi faire ?
Question
Qu'est-ce qui est pire, pour une application informatique, que de ne pas avoir de documentation du tout ?
Réponse
Avoir une documentation obsolète...
En traduisant CakePHP, vous contribuez à la popularité dans les pays francophones d'un framework accessible à tous. Quand une de vos pull requests est acceptée par le dépôt officiel, la doc est déployée en ligne directement : vous voyez immédiatement le fruit de votre travail.
Pour commencer
Les fichiers suivants nécessitent une relecture complète. Certains n'ont même jamais été traduits et sont restés en anglais. La liste n'est pas exhaustive.
fr/development/testing.rst
fr/development/rest.rst
fr/console-commands/shells.rst
fr/orm/behaviors/translate.rst
fr/development/sessions.rst
fr/core-libraries/security.rst
fr/controllers/components/request-handling.rst
fr/controllers/components/pagination.rst
fr/plugins.rst
fr/views/cells.rst