From c02bdde7b35064de6e4fd41428073c5a319e7d4a Mon Sep 17 00:00:00 2001 From: Marine Dunstetter Date: Fri, 8 Dec 2023 18:32:13 +0100 Subject: [PATCH 1/4] docs: delete LISEZMOI.md --- LISEZMOI.md | 66 ----------------------------------------------------- 1 file changed, 66 deletions(-) delete mode 100644 LISEZMOI.md diff --git a/LISEZMOI.md b/LISEZMOI.md deleted file mode 100644 index b3a7981dc..000000000 --- a/LISEZMOI.md +++ /dev/null @@ -1,66 +0,0 @@ -[![Ce projet utilise GitHub Actions pour l'intégration continue.](https://github.com/DazzlingFugu/ember-fr-guides-source/workflows/CI/badge.svg)](https://github.com/DazzlingFugu/ember-fr-guides-source/actions?query=workflow%3ACI) - -# Ember.js Guides en français - -Ce répertoire contient la traduction française du guide officiel Ember.js : - -- [Ember.js Guides, site web](https://github.com/ember-learn/ember-website), -- [Ember Guides Source](https://github.com/ember-learn/guides-source) - -## Contribuer - -Bienvenue et merci pour votre aide ! - -Les nouveaux contributeurs sont encouragés à consulter les problèmes étiquetés **help wanted** ou **good first issue**. Si vous avez des questions ou êtes intéressé par une session de pair, vous pouvez rejoindre [#lang-french](https://discord.com/channels/480462759797063690/486235962700201984) sur [le Discord de la communauté Ember](https://discordapp.com/invite/zT3asNS). - -Veuillez consulter [CONTRIBUTING.md](CONTRIBUTING.md) pour des instructions supplémentaires sur la façon de formater votre travail et de soumettre une PR. - -Le contenu du Guide Ember est écrit en Markdown. En général, votre PR ne devrait modifier que les fichiers du répertoire `/guides/release`, qui correspond à la dernière version d'Ember. - -## Développement local - -**NOTE:** Ce projet utilise [Volta](https://volta.sh/) pour s'assurer que la bonne version de Node.js et de npm est utilisée lors du développement local. - -Pour exécuter l'app Guide Ember localement, saisissez ces commandes dans votre terminal : - -```bash -git clone git://github.com/DazzlingFugu/ember-fr-guides-source.git - -cd ember-fr-guides-source -npm install -ember serve -``` - -Ensuite, visitez [http://localhost:4200](http://localhost:4200) dans votre navigateur. - -Remarque : sur Mac, si vous obtenez l'erreur `Error: EMFILE: too many open files, watch`, essayez d'installer Watchman. Installez [Homebrew](https://brew.sh/) si vous ne l'avez pas. Ensuite, dans votre terminal, lancez `brew install watchman`. - -### Linting et correction orthographique - -Les guides sont soumis à un contrôle orthographique et "lintés" pour la cohérence de Markdown. Vous pouvez vérifier vos modifications en exécutant : - -```bash -npm run lint -``` - -Le linting et la vérification orthographique doivent passer, sinon ils échoueront en CI (intégration continue). Voir [CONTRIBUTING.md](CONTRIBUTING.md) pour plus d'informations sur le linting et la vérification orthographique. - -### Liens internes et externes - -Le test des liens internes et externes peut être effectué à l'aide de trois commandes : - -```bash -# Exécuter tous les scripts de test dans `/node-tests` sauf ceux situés -# dans `/node-tests/local`. En particulier, cette commande vérifie -# tous les liens internes à travers l'application. -npm run test:node - -# Exécuter tous les scripts de test dans `/node-tests/local`. En particulier, -# cette commande vérifie tous les liens externes dans la version de release -# et dans toutes les versions du guide officiel. -npm run test:node-local - -# Lors de la vérification des liens externes dans la version de release, ne pas -# vérifier les liens vers la documentation de l'API (https://api.emberjs.com). -npm run test:node-local-exclude-api-urls -``` From 594f29415b7d890cddc5da6117c24a35133a1df9 Mon Sep 17 00:00:00 2001 From: Marine Dunstetter Date: Fri, 8 Dec 2023 19:11:01 +0100 Subject: [PATCH 2/4] docs: add a contributing guide for grammalecte --- .remarkignore | 1 + CONTRIBUTING.md | 21 ++++++++++++--------- CONTRIBUTING_GRAMMALECTE.md | 21 +++++++++++++++++++++ 3 files changed, 34 insertions(+), 9 deletions(-) create mode 100644 CONTRIBUTING_GRAMMALECTE.md diff --git a/.remarkignore b/.remarkignore index 50e598009..5709d40bf 100644 --- a/.remarkignore +++ b/.remarkignore @@ -1,4 +1,5 @@ CONTRIBUTING.md +CONTRIBUTING_GRAMMALECTE.md README.md MAINTAINERS.md tmp diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2c37aeaf..652e01564 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ Please note that no attempt is made to translate content for older versions of t If it's your first contribution, fork this repository from GitHub interface, then on your machine: ``` git clone -git remote add upstream https://github.com/ember-learn/guides-source.git +git remote add upstream https://github.com/DazzlingFugu/ember-fr-guides-source.git ``` As you tackle new issues, you'll want to be sure that you always start by working on the most recent code. The second command sets an upstream. By pulling from it, you can sync up your fork's `master` branch with its upstream repository's `master` branch. For this to work, make sure you're always committing to a different branch, not `master`. @@ -36,18 +36,21 @@ git switch --create some-branch-name ### 3. Translate and lint the page -Each PR should have: -- **1 commit** (keep the commit stack clean with one commit, and make the message clear enough to identify the issue number or the file at first glance) -- **2~3 files changed** (`[some-page].md`, `.remarkignore`, optionally `.local.dic`) +Here is the journey to submit a PR: +1. Translate the `.md` page of your choice. +2. Once the file is in French, add the path to the page in `.remarkignore` (respect the alphabetical order for readability) +3. Run `npm run lint` -Once you have translated the `.md` page of your choice, you need to run the linter to make sure there's no typo: -- Add the path to your page in `.remarkignore` (respect the alphabetical order for readability) -- Run `npm run lint` - -If there are errors such as "a word is written twice" but it's expected in French (“Je vais vous "faire faire" une jolie traduction”), make sure to fix all the other errors of the same paragraph before adding `` above the paragraph. +The command `npm run lint` runs the tools that will spellcheck your page. If all files are green and the command ends without error, you are good! If there are warnings, you need to fix them. The three most common errors are a misspelled French word, a commonly used English term that you haven't translated on purpose, and a word repeated twice. If there are errors because you kept an English term commonly used in French, add this word to the `.local.dic` file (respect the alphabetical order for readability, lowercase words are below uppercase acronyms). +If there are errors such as "a word is repeated twice" but it's expected in French (“Je vais vous "faire faire" une jolie traduction”), make sure to fix all the other errors of the same paragraph before adding `` above the paragraph. + +Each PR should have: +- **1 commit** (keep the commit stack clean with one commit, and make the message clear enough to identify the issue number or the file at first glance) +- **2~3 files changed** (`[some-page].md`, `.remarkignore`, optionally `.local.dic`) + ### 4. Label your PR Once you're at the point that you'd like feedback: diff --git a/CONTRIBUTING_GRAMMALECTE.md b/CONTRIBUTING_GRAMMALECTE.md new file mode 100644 index 000000000..78e02b1df --- /dev/null +++ b/CONTRIBUTING_GRAMMALECTE.md @@ -0,0 +1,21 @@ +# Installing Grammalecte in Visual Studio + +## Motivation + +This project has a linter configured which can be run with `npm run lint`. This linter consists of a series of [Unified](https://unifiedjs.com/) plugins that spellcheck the French files, and it relies on a French dictionary. It essentially checks that the words exist, among other little things. It's not able to evaluate the grammar like an actual spellchecker. In other words, just because you run `npm run lint` doesn't mean your grammar and conjugation are correct. + +To answer this problem, the current recommendation is to add an actual spellcheck plugin to your code editor. If you use Visual Studio, then you can use Grammalecte. + +## Download Grammalecte + +Visit https://grammalecte.net/#download and select "CLI & Serveur". Once the zip file is downloaded, uncompress it and move it wherever you want on your system. Take good note of the path you choose, you'll need it to configure the plugin in the next step. + +## Add the plugin to Visual Studio + +Open Visual Studio and go to the "Extensions" panel. In the search bar, type in "grammalecte". You should find the plugin posted by jenselme. + +Install the plugin and read carefully the instructions. First, it requires Python3. Then it explains how to let Visual Studio know where to find the Grammalecte script. + +Access the plugin settings by clicking the cog icon next to the uninstall button. In the input "Path To Grammalecte Cli", indicate the path you choose for the Grammalecte folder and point to `grammalecte-cli.py`, as required by the installation instructions. Eventually, have a look at the other options to see what you wish to activate. + +By default, `.md` extension is already present in the list of extensions that Grammalecte can run, so you are good to go! If you have configured everything correctly, you should see Grammalecte underlying things in the documentation files. Don't consider every syntax detail, Grammalecte is not familiar with markdown specifics. Focus on French grammar and conjugation. \ No newline at end of file From cb8a524f4d0c84a76137f1892476eb434e1172eb Mon Sep 17 00:00:00 2001 From: Marine Dunstetter Date: Fri, 8 Dec 2023 19:13:45 +0100 Subject: [PATCH 3/4] docs(contributing): fix a typo and improve Translate and lint --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 652e01564..6de3263da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,6 +51,8 @@ Each PR should have: - **1 commit** (keep the commit stack clean with one commit, and make the message clear enough to identify the issue number or the file at first glance) - **2~3 files changed** (`[some-page].md`, `.remarkignore`, optionally `.local.dic`) +**Grammalecte**: if you use Visual Studio, you can improve the spellchecking tools that will assist you in writing a perfect French file. Check out how to [install Grammalecte plugin in Visual Studio](./CONTRIBUTING_GRAMMALECTE.md). + ### 4. Label your PR Once you're at the point that you'd like feedback: From 41d67e63b52e63bfdc41944b03cc4e238c12da8f Mon Sep 17 00:00:00 2001 From: Marine Dunstetter Date: Tue, 12 Dec 2023 10:07:16 +0100 Subject: [PATCH 4/4] docs(contributing): apply suggestions from code review Co-authored-by: MrChocolatine <47531779+MrChocolatine@users.noreply.github.com> --- CONTRIBUTING.md | 6 +++--- CONTRIBUTING_GRAMMALECTE.md | 16 ++++++++-------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6de3263da..a798f8cd2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,12 +38,12 @@ git switch --create some-branch-name Here is the journey to submit a PR: 1. Translate the `.md` page of your choice. -2. Once the file is in French, add the path to the page in `.remarkignore` (respect the alphabetical order for readability) +2. Once the file is in French, add the path of the page to the `.remarkignore` file (in alphabetical order) 3. Run `npm run lint` The command `npm run lint` runs the tools that will spellcheck your page. If all files are green and the command ends without error, you are good! If there are warnings, you need to fix them. The three most common errors are a misspelled French word, a commonly used English term that you haven't translated on purpose, and a word repeated twice. -If there are errors because you kept an English term commonly used in French, add this word to the `.local.dic` file (respect the alphabetical order for readability, lowercase words are below uppercase acronyms). +If there are errors because you kept an English term commonly used in French, add this word to the `.local.dic` file (in alphabetical order, lowercase words are below uppercase acronyms). If there are errors such as "a word is repeated twice" but it's expected in French (“Je vais vous "faire faire" une jolie traduction”), make sure to fix all the other errors of the same paragraph before adding `` above the paragraph. @@ -51,7 +51,7 @@ Each PR should have: - **1 commit** (keep the commit stack clean with one commit, and make the message clear enough to identify the issue number or the file at first glance) - **2~3 files changed** (`[some-page].md`, `.remarkignore`, optionally `.local.dic`) -**Grammalecte**: if you use Visual Studio, you can improve the spellchecking tools that will assist you in writing a perfect French file. Check out how to [install Grammalecte plugin in Visual Studio](./CONTRIBUTING_GRAMMALECTE.md). +**Grammalecte**: if you use Visual Studio Code, you can improve the spellchecking tools that will assist you in writing a perfect file in French. Check out how to [install Grammalecte plugin in Visual Studio Code](./CONTRIBUTING_GRAMMALECTE.md). ### 4. Label your PR diff --git a/CONTRIBUTING_GRAMMALECTE.md b/CONTRIBUTING_GRAMMALECTE.md index 78e02b1df..5a1307fdd 100644 --- a/CONTRIBUTING_GRAMMALECTE.md +++ b/CONTRIBUTING_GRAMMALECTE.md @@ -1,21 +1,21 @@ -# Installing Grammalecte in Visual Studio +# Installing Grammalecte in Visual Studio Code ## Motivation -This project has a linter configured which can be run with `npm run lint`. This linter consists of a series of [Unified](https://unifiedjs.com/) plugins that spellcheck the French files, and it relies on a French dictionary. It essentially checks that the words exist, among other little things. It's not able to evaluate the grammar like an actual spellchecker. In other words, just because you run `npm run lint` doesn't mean your grammar and conjugation are correct. +This project has a linter which can be run with `npm run lint`. This linter consists of a series of [Unified](https://unifiedjs.com/) plugins that spellcheck the files in French, and it relies on a French dictionary. It essentially checks words exist, among other little things. It's not able to evaluate the grammar like an actual spellchecker. In other words, just because you run `npm run lint` doesn't mean your grammar and conjugation are correct. -To answer this problem, the current recommendation is to add an actual spellcheck plugin to your code editor. If you use Visual Studio, then you can use Grammalecte. +To answer this problem, the current recommendation is to add an actual spellcheck plugin to your code editor. If you use Visual Studio Code, then you can use Grammalecte. ## Download Grammalecte -Visit https://grammalecte.net/#download and select "CLI & Serveur". Once the zip file is downloaded, uncompress it and move it wherever you want on your system. Take good note of the path you choose, you'll need it to configure the plugin in the next step. +Visit https://grammalecte.net/#download and select "CLI & Serveur". Once the zip file is downloaded, decompress it and move it wherever you want on your system. Take good note of the path you choose, you'll need it to configure the plugin in the next step. -## Add the plugin to Visual Studio +## Add the plugin to Visual Studio Code -Open Visual Studio and go to the "Extensions" panel. In the search bar, type in "grammalecte". You should find the plugin posted by jenselme. +Open Visual Studio Code and open the "Extensions" panel. In the search bar, type in "grammalecte", you should find this plugin: https://marketplace.visualstudio.com/items?itemName=jenselme.grammalecte . -Install the plugin and read carefully the instructions. First, it requires Python3. Then it explains how to let Visual Studio know where to find the Grammalecte script. +Install the plugin and read carefully the instructions. First, it requires Python3. Then it explains how to let Visual Studio Code know where to find the Grammalecte script. Access the plugin settings by clicking the cog icon next to the uninstall button. In the input "Path To Grammalecte Cli", indicate the path you choose for the Grammalecte folder and point to `grammalecte-cli.py`, as required by the installation instructions. Eventually, have a look at the other options to see what you wish to activate. -By default, `.md` extension is already present in the list of extensions that Grammalecte can run, so you are good to go! If you have configured everything correctly, you should see Grammalecte underlying things in the documentation files. Don't consider every syntax detail, Grammalecte is not familiar with markdown specifics. Focus on French grammar and conjugation. \ No newline at end of file +By default, `.md` extension is already present in the list of extensions that Grammalecte can run, so you are good to go! If you have configured everything correctly, you should see Grammalecte underlining things in the documentation files. Don't consider every syntax detail, Grammalecte is not familiar with markdown specifics. Focus on French grammar and conjugation. \ No newline at end of file