diff options
| author | 2019-12-03 22:37:40 +0100 | |
|---|---|---|
| committer | 2019-12-03 22:37:40 +0100 | |
| commit | 705318aa39a605a4d869db588f6cffb12019a611 (patch) | |
| tree | 36383dfee24999f9928957621b655e67b20714b7 /docs/fr/developers/01_First_steps.md | |
| parent | 0de7e84380dff5222e6728aacbbb42abaac51dd9 (diff) | |
Translate docs with po4a (#2590)
* [i18n] Add docs po4a script
* Add proof of concept
* Add a few more translations
* Hush ShellCheck and shfmt
* Make that list po4a-friendly
* drat, this document could've probably been auto-generated
* Definitive proof that it's translated from French ;-)
* Add some brand spanking new French translation
* More translation
* Mostly finish that config page
* Fix up FAQ
* More contributing
* Dev first steps
* Let's ignore that admin stuff at the very least for now
* Translate release new version, make French the source first and copy all translations
Then replace French with English in the source.
Much quicker than any alternative route.
* And add the English translation
* Minor stylistic leftover from French
* Most of first steps
* Forgot the extensions
* Use po4a 0.56 to get rid of way too many newlines
* Fix up those newlines
* No point linking to Firefox integration anymore from the new user guide
* Start on main view
* A bunch of main view stuff
* More main view
* And some subscriptions before going to bed
* First steps for devs
* More dev first steps
* Incomplete French → English dev/GH translation
Because I need to ask about that mailing list thing
* Fix typo in docs/en/developers/02_Github.md
* Translate & complete devs/github to English
* Fix up most of extensions
* Is that supposed to be a non-breaking space? Let's see
* Match up some users/mobile access
* More users/mobile access
* Add fresh French translation to Fever API
* Fix typo
* Match frontend todo thingies
* Fix a typo
* Some extensions strings
* Remove Fx subscription service from the docs
Cf. https://github.com/FreshRSS/FreshRSS/pull/2606
* Add translation for https://github.com/FreshRSS/FreshRSS/pull/2643
* fix typo as per https://github.com/FreshRSS/FreshRSS/pull/2643#discussion_r345433009
* Add some more French translations
* Update French translation as per @aledeg comment https://github.com/FreshRSS/FreshRSS/pull/2590#discussion_r345465909
* Translate some of the meaningless stuff
* Translate the rest of contributing.md to French
* Fix conflicts
* Translate Docker first steps to French
* Update with change from #2665
* Add @aledeg corrections
* Overlooked a couple @aledeg corrections thanks to GitHub autohide
* Latest @aledeg suggestions
Diffstat (limited to 'docs/fr/developers/01_First_steps.md')
| -rw-r--r-- | docs/fr/developers/01_First_steps.md | 147 |
1 files changed, 126 insertions, 21 deletions
diff --git a/docs/fr/developers/01_First_steps.md b/docs/fr/developers/01_First_steps.md index df3fa65f2..2efa65991 100644 --- a/docs/fr/developers/01_First_steps.md +++ b/docs/fr/developers/01_First_steps.md @@ -1,20 +1,105 @@ -# Configurer son environnement +# Configurer son environnement (Docker) + +FreshRSS est construit en PHP et utilise le framework Minz. Les +dépendancessont directement incluses dans le code source, donc vous n'avez +pas besoin d'utiliser Composer. + +Il existe plusieurs façons de configurer votre environnement +dedéveloppement. La méthode la plus simple et la plus supportée est basée +surDocker. C'est la solution qui est documentée ci-dessous. Si vous avez +déjà unenvironnement PHP fonctionnel, vous n'en avez probablement pas +besoin. + +Nous supposons ici que vous utilisez une distribution GNU/Linux, capable +d'exécuter Docker. Sinon, vous devrez adapter les commandes en conséquence. + +Les commandes qui suivent doivent être exécutées dans une console. Ils +commencent par `$` quand les commandes doivent être exécutées en tant +qu'utilisateur normal, et par `#` quand elles doivent être exécutées en tant +qu'utilisateur root. Vous n'avez pas besoin de taper ces caractères. Un +chemin d'accès peut être indiqué devant ces caractères pour vous aider à +identifier où ils doivent être exécutés. Par exemple, `app$ echo 'Hello +World'` indique que vous devez exécuter la commande `echo` dans le +répertoire `app/`. + +Tout d'abord, vous devez installer +[Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/). + +Une fois que c'est fait, clonez le dépôt de code de la manière suivante : + +```console +$ git clone https://github.com/FreshRSS/FreshRSS.git +$ cd FreshRSS +``` + +Notez que, pour contribuer, vous devrez d'abord « forker » ce dépôt de code +(ou dépôt de code référent) et cloner votre « fork » à la place de ce +dépôt. Adaptez les commandes en conséquence. + +Ensuite, la seule commande que vous devez connaître est la suivante : + +```console +$ make start +``` + +Cela peut prendre un certain temps pour que Docker télécharge l'image +utilisée. Dans le cas où la commande échoue pour un problème de droit, il +faudra soit ajouter votre utilisateur au groupe `docker`, soit relancer la +commande en la préfixant par `sudo`. + +**Vous pouvez maintenant accéder à FreshRSS à [http://localhost:8080](http://localhost:8080).** Suivez simplement le processus d'installation et sélectionnez la base de données SQLite. + +Vous pouvez arrêter les conteneurs en tapant <kbd>Control</kbd> + <kbd>c</kbd> ou avec la commande suivante, dans un autre terminal: + +```console +$ make stop +``` -**TODO** +Si la configuration vous intéresse, les commandes `make' sont définies dans +le fichier [`Makefile`](/Makefile). -## Docker +Si vous avez besoin d'utiliser une image Docker identifiée par un tag +différent (par défaut `dev-alpine`), vous pouvez surcharger de la manière +suivante la variable d'environnement `TAG` au moment de l'exécution de la +commande : -Le développement et le deploiement de FreshRSS peuvent se faire [via Docker](https://github.com/FreshRSS/FreshRSS/tree/dev/Docker). +```console +$ TAG=dev-arm make start +``` + +Vous pouvez trouver la liste complète des tags disponibles [sur le hub +Docker](https://hub.docker.com/r/freshrss/freshrss/tags). + +Si vous voulez construire l'image Docker, vous pouvez lancer la commande +suivante : + +```console +$ make build +$ # ou +$ TAG=dev-arm make build +``` + +La valeur de la variable `TAG` peut contenir n'importe quelle valeur (par +exemple `dev-local`). Vous pouvez cibler une architecture spécifique en +ajoutant `-alpine` ou `-arm` à la fin du tag (par exemple `dev-local-arm`). # Architecture du projet -**TODO** +**À FAIRE** + +# Extensions + +Si vous souhaitez créer votre propre extension FreshRSS, consultez la +[documentation de l'extension](03_Backend/05_Extensions.md). # Style de codage -Si vous désirez contribuer au code, il est important de respecter le style de codage suivant. Le code actuel ne le respecte pas entièrement mais il est de notre devoir à tous de le changer dès que l'occasion se présente. +Si vous désirez contribuer au code, il est important de respecter le style +de codage suivant. Le code actuel ne le respecte pas entièrement mais il est +de notre devoir à tous de le changer dès que l'occasion se présente. -Aucune nouvelle contribution ne respectant pas ces règles ne sera acceptée tant que les corrections nécessaires ne sont pas appliquées. +Aucune nouvelle contribution ne respectant pas ces règles ne sera acceptée +tant que les corrections nécessaires ne sont pas appliquées. ## Espaces, tabulations et autres caractères blancs @@ -23,7 +108,8 @@ L'indentation du code doit être faite impérativement avec des tabulations. ### Alignement -Une fois l'indentation faite, il peut être nécessaire de faire un alignement pour simplifier la lecture. Dans ce cas, il faut utiliser les espaces. +Une fois l'indentation faite, il peut être nécessaire de faire un alignement +pour simplifier la lecture. Dans ce cas, il faut utiliser les espaces. ```php $resultat = une_fonction_avec_un_nom_long($param1, $param2, @@ -32,9 +118,12 @@ $resultat = une_fonction_avec_un_nom_long($param1, $param2, ### Fin de ligne -Le caractère de fin de ligne doit être un saut de ligne (LF) qui est le caractère de fin de ligne des systèmes *NIX. Ce caractère ne doit pas être précédé par des caractères blanc. +Le caractère de fin de ligne doit être un saut de ligne (LF) qui est le +caractère de fin de ligne des systèmes *NIX. Ce caractère ne doit pas être +précédé par des caractères blanc. -Il est possible de vérifier la présence de caractères blancs en fin de ligne grâce à Git avec la commande suivante : +Il est possible de vérifier la présence de caractères blancs en fin de ligne +grâce à Git avec la commande suivante : ```bash # commande à lancer avant l'ajout des fichiers dans l'index @@ -65,7 +154,10 @@ echo $a ? 1 : 0; ### Le cas des parenthèses -Il n'y a pas d'espaces entre des parenthèses. Il n'y a pas d'espaces avant une parenthèse ouvrante sauf si elle est précédée d'un mot-clé. Il n'y a pas d'espaces après une parenthèse fermante sauf si elle est suivie d'une accolade ouvrante. +Il n'y a pas d'espaces entre des parenthèses. Il n'y a pas d'espaces avant +une parenthèse ouvrante sauf si elle est précédée d'un mot-clé. Il n'y a pas +d'espaces après une parenthèse fermante sauf si elle est suivie d'une +accolade ouvrante. ```php if ($a == 10) { @@ -79,7 +171,11 @@ if ((int)$a == 10) { ### Le cas des fonctions chainées -Ce cas se présente le plus souvent en Javascript. Quand on a des fonctions chainées, des fonctions anonymes ainsi que des fonctions de rappels, il est très facile de se perdre. Dans ce cas là, on ajoute une indentation supplémentaire pour toute l'instruction et on revient au même niveau pour une instruction de même niveau. +Ce cas se présente le plus souvent en Javascript. Quand on a des fonctions +chainées, des fonctions anonymes ainsi que des fonctions de rappels, il est +très facile de se perdre. Dans ce cas là, on ajoute une indentation +supplémentaire pour toute l'instruction et on revient au même niveau pour +une instruction de même niveau. ```javascript // Première instruction @@ -98,9 +194,13 @@ shortcut.add("shift+" + shortcuts.mark_read, function () { ## Longueur des lignes -Les lignes ne doivent pas dépasser 80 caractères. Il est cependant autorisé exceptionnellement de dépasser cette limite s'il n'est pas possible de la respecter mais en aucun cas, les lignes ne doivent dépasser les 100 caractères. +Les lignes ne doivent pas dépasser 80 caractères. Il est cependant autorisé +exceptionnellement de dépasser cette limite s'il n'est pas possible de la +respecter mais en aucun cas, les lignes ne doivent dépasser les 100 +caractères. -Dans le cas des fonctions, les paramètres peuvent être déclarés sur plusieurs lignes. +Dans le cas des fonctions, les paramètres peuvent être déclarés sur +plusieurs lignes. ```php function ma_fonction($param_1, $param_2, @@ -111,7 +211,8 @@ function ma_fonction($param_1, $param_2, ## Nommage -L'ensemble des éléments du code (fonctions, classes, méthodes et variables) doivent être nommés de manière à décrire leur usage de façon concise. +L'ensemble des éléments du code (fonctions, classes, méthodes et variables) +doivent être nommés de manière à décrire leur usage de façon concise. ### Fonctions et variables @@ -150,12 +251,14 @@ Les fichiers doivent être encodés en UTF-8. ## Compatibilité PHP -Assurez-vous que votre code fonctionne avec une version de PHP aussi ancienne que celle que FreshRSS supporte officiellement. +Assurez-vous que votre code fonctionne avec une version de PHP aussi +ancienne que celle que FreshRSS supporte officiellement. ## Divers -### Opérateurs -Les opérateurs doivent être en fin de ligne dans le cas de conditions sur plusieurs lignes. +### Le cas des opérateurs +Les opérateurs doivent être en fin de ligne dans le cas de conditions sur +plusieurs lignes. ```php if ($a == 10 || @@ -164,13 +267,15 @@ if ($a == 10 || } ``` -### Fin des fichiers +### Fin de fichier -Si le fichier ne contient que du PHP, il ne doit pas comporter de balise fermante +Si le fichier ne contient que du PHP, il ne doit pas comporter de balise +fermante. ### Tableaux -Lors de l'écriture de tableaux sur plusieurs lignes, tous les éléments doivent être suivis d'une virgule (même le dernier). +Lors de l'écriture de tableaux sur plusieurs lignes, tous les éléments +doivent être suivis d'une virgule (même le dernier). ```php $variable = [ |
