diff options
| author | 2021-03-15 00:00:25 +0100 | |
|---|---|---|
| committer | 2021-03-15 00:00:25 +0100 | |
| commit | 1c3159058fd256ec7163a29c9865dbd3dbe05f17 (patch) | |
| tree | 5b3a9df3cc709a4b370f6f03cf79c50483275344 /docs/fr | |
| parent | 769f34e958b50e748acf6a151805f4a255df2043 (diff) | |
Quick update the doc for master renaming to edge
Diffstat (limited to 'docs/fr')
| -rw-r--r-- | docs/fr/contributing.md | 5 | ||||
| -rw-r--r-- | docs/fr/developers/01_First_steps.md | 2 | ||||
| -rw-r--r-- | docs/fr/developers/02_Github.md | 34 | ||||
| -rw-r--r-- | docs/fr/developers/03_Running_tests.md | 12 | ||||
| -rw-r--r-- | docs/fr/developers/05_Release_new_version.md | 26 | ||||
| -rw-r--r-- | docs/fr/users/01_Installation.md | 24 | ||||
| -rw-r--r-- | docs/fr/users/04_Subscriptions.md | 15 |
7 files changed, 63 insertions, 55 deletions
diff --git a/docs/fr/contributing.md b/docs/fr/contributing.md index a58f4fac4..bb67db304 100644 --- a/docs/fr/contributing.md +++ b/docs/fr/contributing.md @@ -61,7 +61,7 @@ les collaborateurs, vous devrez suivre ces indications : Si vous devez écrire du code, veuillez suivre [nos recommandations de style de codage](developers/01_First_steps.md). -**Conseil : **si vous cherchez des bugs faciles à corriger, jetez un coup d'oeil à la vignette "[good first issue](https://github.com/FreshRSS/FreshRSS/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)". +**Conseil :** si vous cherchez des bugs faciles à corriger, jetez un coup d'oeil à la vignette "[good first issue](https://github.com/FreshRSS/FreshRSS/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)". ## Soumettre une idée @@ -86,5 +86,4 @@ mais n'hésitez pas à nous suggérer des idées ! Il ne vous aura pas échappé que la documentation est encore un peu vide… il y a énormément de choses à faire ! Si vous souhaitez aider à écrire quelques -pages, rendez-vous dans les principaux dépôts[fichier -docs](https://github.com/FreshRSS/FreshRSS/tree/master/docs) ! +pages, rendez-vous dans les principaux dépôts [fichier docs](https://github.com/FreshRSS/FreshRSS/tree/edge/docs) ! diff --git a/docs/fr/developers/01_First_steps.md b/docs/fr/developers/01_First_steps.md index e7c862ae5..8c2bf4505 100644 --- a/docs/fr/developers/01_First_steps.md +++ b/docs/fr/developers/01_First_steps.md @@ -125,7 +125,7 @@ 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 : -```bash +```sh # commande à lancer avant l'ajout des fichiers dans l'index git diff --check # commande à lancer après l'ajout des fichiers dans l'index mais avant le commit diff --git a/docs/fr/developers/02_Github.md b/docs/fr/developers/02_Github.md index 724e56e8a..d850dee09 100644 --- a/docs/fr/developers/02_Github.md +++ b/docs/fr/developers/02_Github.md @@ -30,7 +30,7 @@ pas cet aspect "social" ! français :) 5. Merci de bien vouloir suivre les quelques conseils donnés plus bas pour faciliter la prise en compte de votre ticket. - + ## De façon informelle Tout le monde n'aime pas ou n'utilise pas GitHub pour des raisons aussi @@ -104,9 +104,10 @@ Pensez à donner les informations suivantes si vous les connaissez : version ? 5. Quelle distribution sur le serveur ? Et… quelle version ? -# Système de branches +## Système de branches + +### Élémentaire -## Élémentaire Si vous êtes novice dans Git, voici quelques ressources qui pourraient vous être utiles : @@ -115,33 +116,38 @@ Si vous êtes novice dans Git, voici quelques ressources qui pourraient vous * <http://sixrevisions.com/resources/git-tutorials-beginners/> * <http://rogerdudler.github.io/git-guide/> -## Obtenir le dernier code du répertoire FreshRSS +### Obtenir le dernier code du répertoire FreshRSS + Vous devez avant tout ajouter le repo officiel à votre liste de repo remote : -```bash + +```sh git remote add upstream git@github.com:FreshRSS/FreshRSS.git ``` Vous pouvez vérifier que le repo remote a été ajouté avec succès en utilisant : -```bash + +```sh git remote -v show ``` Vous pouvez maintenant pull le dernier code de développement : -```bash -git checkout master -git pull upstream master + +```sh +git checkout edge +git pull upstream edge ``` -## Lancer une nouvelle branche de développement -```bash +### Lancer une nouvelle branche de développement + +```sh git checkout -b mon-branch-developpement ``` -# Proposer un patch +## Proposer un patch -```bash +```sh # Ajoutez le fichier modifié, ici actualize_script.php git add app/actualize_script.php # Commitez le changement et écrivez un message de commit approprié. @@ -154,7 +160,7 @@ git push Vous pouvez maintenant créer une PR en fonction de votre branche. -## Comment écrire un message de commit +### Comment écrire un message de commit Un message de commit devrait décrire succinctement les changements sur la première ligne. Par exemple : diff --git a/docs/fr/developers/03_Running_tests.md b/docs/fr/developers/03_Running_tests.md index 70aafc02a..90a4b72ef 100644 --- a/docs/fr/developers/03_Running_tests.md +++ b/docs/fr/developers/03_Running_tests.md @@ -1,15 +1,15 @@ # Running tests FreshRSS is tested with [PHPUnit](https://phpunit.de/). No code should be -merged in `master` if the tests don't pass. +merged in `edge` if the tests don't pass. ## Locally As a developer, you can run the test suite on your PC easily with `make` commands. You can run the test suite with: -```console -$ make test +```sh +make test ``` This command downloads the PHPUnit binary and verifies its checksum. If the @@ -20,8 +20,8 @@ maintainers know about the problem. Then, it executes PHPUnit in a Docker container. If you don't use Docker, you can run the command directly with: -```console -$ NO_DOCKER=true make test +```sh +NO_DOCKER=true make test ``` ## Travis @@ -32,4 +32,4 @@ done to ensure there is no regressions in your code. We cannot merge a PR if the tests fail so we'll ask you to fix bugs before to review your code. If you're interested in, you can take a look at [the configuration -file](https://github.com/FreshRSS/FreshRSS/blob/master/.travis.yml). +file](https://github.com/FreshRSS/FreshRSS/blob/edge/.travis.yml). diff --git a/docs/fr/developers/05_Release_new_version.md b/docs/fr/developers/05_Release_new_version.md index face8d5cb..116d50ca6 100644 --- a/docs/fr/developers/05_Release_new_version.md +++ b/docs/fr/developers/05_Release_new_version.md @@ -7,7 +7,7 @@ Ceci est à faire **au moins une semaine à l'avance**. Il est aussi recommandé de faire l'annonce sur mailing@freshrss.org. -# S'assurer de l'état de dev +## S'assurer de l'état de dev Avant de sortir une nouvelle version de FreshRSS, il faut vous assurer que le code est stable et ne présente pas de bugs majeurs. Idéalement, il @@ -17,10 +17,10 @@ publication. Il faut aussi **vous assurer que le fichier CHANGELOG est à jour** avec les mises à jour de la version à sortir. -# Processus Git +## Processus Git -```bash -$ git checkout master +```sh +$ git checkout edge $ git pull $ vim constants.php # Mettre à jour le numéro de version x.y.z de FRESHRSS_VERSION @@ -31,7 +31,7 @@ Version x.y.z $ git push && git push --tags ``` -# Mise à jour de update.freshrss.org +## Mise à jour de update.freshrss.org Il est important de mettre à jour update.freshrss.org puisqu'il s'agit du service par défaut gérant les mises à jour automatiques de FreshRSS. @@ -39,11 +39,11 @@ service par défaut gérant les mises à jour automatiques de FreshRSS. Le dépot gérant le code se trouve sur GitHub : [FreshRSS/update.freshrss.org](https://github.com/FreshRSS/update.freshrss.org/). -## Écriture du script de mise à jour +### Écriture du script de mise à jour Les scripts se trouvent dans le répertoire `./scripts/` et doivent être de la forme `update_to_x.y.z.php`. On trouve aussi dans ce répertoire -`update_to_dev.php` destiné aux mises à jour de la branche `master` (ce +`update_to_dev.php` destiné aux mises à jour de la branche `edge` (ce script ne doit pas inclure de code spécifique à une version particulière !) et `update_util.php` contenant une liste de fonctions utiles à tous les scripts. @@ -98,7 +98,7 @@ return array( Et voici comment fonctionne cette table : * à gauche se trouve la version N, à droite la version N+1 ; -* les versions `x.y.z-dev` sont **toutes** mises à jour vers `master` ; +* les versions `x.y.z-dev` sont **toutes** mises à jour vers `edge` ; * les versions stables sont mises à jour vers des versions stables ; * il est possible de sauter plusieurs versions d'un coup à condition que les scripts de mise à jour le prennent en charge ; @@ -121,7 +121,7 @@ déroule correctement. Lorsque vous serez satisfait, mettez à jour update.freshrss.org avec le nouveau script et en testant de nouveau puis passez à la suite. -# Mise à jour des services FreshRSS +## Mise à jour des services FreshRSS Deux services sont à mettre à jour immédiatement après la mise à jour de update.freshrss.org : @@ -129,7 +129,7 @@ update.freshrss.org : * rss.freshrss.org ; * demo.freshrss.org (identifiants publics : `demo` / `demodemo`). -# Annoncer publiquement la sortie +## Annoncer publiquement la sortie Lorsque tout fonctionne, il est temps d'annoncer la sortie au monde entier ! @@ -141,10 +141,10 @@ Lorsque tout fonctionne, il est temps d'annoncer la sortie au monde entier ! * sur Twitter (compte [@FreshRSS](https://twitter.com/FreshRSS)) ; * et sur mailing@freshrss.org ; -# Lancer la prochaine version de développement +## Lancer la prochaine version de développement -```bash -$ git checkout master +```sh +$ git checkout edge $ vim constants.php # Mettre à jour le numéro de version de FRESHRSS_VERSION $ vim CHANGELOG.md diff --git a/docs/fr/users/01_Installation.md b/docs/fr/users/01_Installation.md index 2f31e4c77..9ef5ea6c5 100644 --- a/docs/fr/users/01_Installation.md +++ b/docs/fr/users/01_Installation.md @@ -8,29 +8,29 @@ Il est toutefois de votre responsabilité de vérifier que votre hébergement pe | -------- | ----------- | --------------------- | | Serveur web | **Apache 2** | Nginx | | PHP | **PHP 7+** | PHP 5.6+ | - | Modules PHP | Requis : libxml, cURL, JSON, PDO_MySQL, PCRE et ctype<br>Requis (32 bits seulement) : GMP<br>Recommandé : Zlib, mbstring et iconv, ZipArchive<br>*Pour une liste complète des modules nécessaires voir le [Dockerfile](https://github.com/FreshRSS/FreshRSS/blob/master/Docker/Dockerfile-Alpine#L7-L9)* | | + | Modules PHP | Requis : libxml, cURL, JSON, PDO_MySQL, PCRE et ctype<br />Requis (32 bits seulement) : GMP<br />Recommandé : Zlib, mbstring et iconv, ZipArchive<br />*Pour une liste complète des modules nécessaires voir le [Dockerfile](https://github.com/FreshRSS/FreshRSS/blob/edge/Docker/Dockerfile-Alpine#L7-L9)* | | | Base de données | **MySQL 5.5.3+** | SQLite 3.7.4+, PostgreSQL 9.5+ | | Navigateur | **Firefox** | Chrome, Opera, Safari, or IE 11+ | -# Choisir la bonne version de FreshRSS +## Choisir la bonne version de FreshRSS FreshRSS possède trois versions différentes (nous parlons de branches) qui sortent à des fréquences plus ou moins rapides. Aussi prenez le temps de comprendre à quoi correspond chacune de ces versions. -## La version stable +### La version stable -[Téléchargement](https://github.com/FreshRSS/FreshRSS/archive/master.zip) +[Téléchargement](https://github.com/FreshRSS/FreshRSS/archive/latest.zip) Cette version sort lorsqu’on considère qu’on a répondu à nos objectifs en terme de nouvelles fonctionnalités. Deux versions peuvent ainsi sortir de façon très rapprochée si les développeurs travaillent bien. En pratique, comme nous nous fixons de nombreux objectifs et que nous travaillons sur notre temps libre, les versions sont souvent assez espacées (plusieurs mois). Son avantage est que le code est particulièrement stable et vous ne devriez pas faire face à de méchants bugs. -## La version de développement +### La version de développement -[Téléchargement](https://github.com/FreshRSS/FreshRSS/archive/dev.zip) +[Téléchargement](https://github.com/FreshRSS/FreshRSS/archive/edge.zip) -Comme son nom l’indique, il s’agit de la version sur laquelle les développeurs travaillent. **Elle est donc instable !** Si vous souhaitez recevoir les améliorations au jour le jour, vous pouvez l’utiliser, mais attention à bien suivre les évolutions sur Github (via [le flux RSS de la branche](https://github.com/FreshRSS/FreshRSS/commits/dev.atom) par exemple). On raconte que les développeurs principaux l’utilisent quotidiennement sans avoir de soucis. Sans doute savent-ils ce qu’ils font… +Comme son nom l’indique, il s’agit de la version sur laquelle les développeurs travaillent. **Elle est donc instable !** Si vous souhaitez recevoir les améliorations au jour le jour, vous pouvez l’utiliser, mais attention à bien suivre les évolutions sur Github (via [le flux RSS de la branche](https://github.com/FreshRSS/FreshRSS/commits/edge.atom) par exemple). On raconte que les développeurs principaux l’utilisent quotidiennement sans avoir de soucis. Sans doute savent-ils ce qu’ils font… -# Installation sur Apache +## Installation sur Apache -``` +```apache <VirtualHost *:80> DocumentRoot /var/www/html/ @@ -84,13 +84,13 @@ Comme son nom l’indique, il s’agit de la version sur laquelle les développe </IfModule> ``` -# Installation sur Nginx +## Installation sur Nginx Voici un fichier de configuration pour nginx. Il couvre la configuration pour HTTP, HTTPS, et PHP. _Vous pourrez trouver d’autres fichiers de configuration plus simples mais ces derniers ne seront peut-être pas compatibles avec l’API FreshRSS._ -``` +```nginx server { listen 80; listen 443 ssl; @@ -135,6 +135,6 @@ server { Pour un tutoriel pas à pas, vous pouvez suivre [cet article dédié](http://www.pihomeserver.fr/2013/05/08/raspberry-pi-home-server-installer-un-agregateur-de-flux-rss-pour-remplacer-google-reader/). -# Conseils de sécurité +## Conseils de sécurité **TODO** diff --git a/docs/fr/users/04_Subscriptions.md b/docs/fr/users/04_Subscriptions.md index af55bec80..2c5808fbf 100644 --- a/docs/fr/users/04_Subscriptions.md +++ b/docs/fr/users/04_Subscriptions.md @@ -5,8 +5,10 @@ 3. Collez l’URL du flux dans le champ « Ajouter un flux RSS » juste en dessous du titre. 4. (facultatif) : Vous pouvez descendre jusqu’à « Catégorie » et sélectionner la catégorie dans laquelle vous souhaitez enregistrer votre flux. Par défaut, le nouveau flux sera dans « Sans catégorie ». -# Import et export -Voir [export/import SQLite]( https://github.com/FreshRSS/FreshRSS/tree/master/cli) pour une alternative. +## Import et export + +Voir [export/import SQLite]( https://github.com/FreshRSS/FreshRSS/tree/edge/cli) pour une alternative. + ## Exportation 1. Pour exporter votre liste d’abonnements, allez dans « Gestion des abonnements ». @@ -18,8 +20,8 @@ Voir [export/import SQLite]( https://github.com/FreshRSS/FreshRSS/tree/master/cl 4. et enfin, vous pouvez sélectionner les flux que vous voulez exporter (par défaut tous les flux sont sélectionnés) 4. Cliquez sur « Exporter ». - ## Importation - +## Importation + 1. Pour importer un fichier d’abonnement vers votre compte FreshRSS, allez dans l’espace « Importer / exporter » comme ci-dessus 2. Cliquez sur « Parcourir » et sélectionnez votre fichier sur votre ordinateur. 3. Validez en cliquant sur « Importer ». @@ -27,11 +29,12 @@ Voir [export/import SQLite]( https://github.com/FreshRSS/FreshRSS/tree/master/cl > **Important**: vous ne pouvez pas importer directement depuis un fichier texte. > Vous devez le convertir au format _OPML_ au préalable. > Voici une liste d’outils que vous pouvez utiliser : +> > - [Pandoc](https://pandoc.org/) disponible sur la plus part des systèmes, > - [OPML generator](https://opml-gen.ovh/) disponible en ligne, > - [txt2opml](https://alterfiles.com/convert/txt/opml) disponible en ligne. -# Utiliser le « bookmarklet » +## Utiliser le « bookmarklet » Les « bookmarklets » sont de petits scripts que vous pouvez exécuter pour effectuer des tâches diverses et variées. FreshRSS offre un signet « bookmark » pour s’abonner aux fils de nouvelles. @@ -40,7 +43,7 @@ Les « bookmarklets » sont de petits scripts que vous pouvez exécuter pour eff 3. Glissez le bouton « S’abonner » dans la barre d’outils des signets ou cliquez droit et choisissez l’action « Lien vers les signets » de votre navigateur. -# Organisation des flux +## Organisation des flux Vous pouvez trier vos flux dans différentes catégories. Un flux ne peut être que dans une seule catégorie. |
