From db2f488476ecd8be8ff1b9d29fae8d2c8e688efb Mon Sep 17 00:00:00 2001 From: Orta Date: Thu, 22 Jul 2021 20:42:46 +0100 Subject: [PATCH 1/3] Adds french --- .github/CODEOWNERS | 7 +++++++ localize.json | 6 ++++-- starting_new_language.md | 20 ++++++++++++++++++++ 3 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 starting_new_language.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 80f30986..329c3901 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -62,3 +62,10 @@ docs/tsconfig/it/**/*.md @Nabster101 @DeltaPy @PyGera [translation] [it] docs/typescriptlang/it/**/*.ts @Nabster101 @DeltaPy @PyGera [translation] [it] docs/typescriptlang/it.ts @Nabster101 @DeltaPy @PyGera [translation] [it] docs/documentation/it/**/*.md @Nabster101 @DeltaPy @PyGera [translation] [it] + +# Collaborators for French Translation of the Website +docs/playground/fr @ManuSquall [translation] [fr] +docs/tsconfig/fr/**/*.md @ManuSquall [translation] [fr] +docs/typescriptlang/fr/**/*.ts @ManuSquall [translation] [fr] +docs/typescriptlang/fr.ts @ManuSquall [translation] [fr] +docs/documentation/fr/**/*.md @ManuSquall [translation] [fr] diff --git a/localize.json b/localize.json index 1353cd60..ba7bbc83 100644 --- a/localize.json +++ b/localize.json @@ -9,7 +9,8 @@ "id": 7, "uk": 8, "pl": 9, - "it": 10 + "it": 10, + "fr": 100 }, "docsRoots": [ { "name": "Playground", "from": "packages/playground-examples/copy/", "to": "docs/playground" }, @@ -25,7 +26,8 @@ "docs/typescriptlang/pl/pl.ts", "docs/typescriptlang/pt/pt.ts", "docs/typescriptlang/vo/vo.ts", - "docs/typescriptlang/zh/zh.ts" + "docs/typescriptlang/zh/zh.ts", + "docs/typescriptlang/fr/fr.ts" ] } } diff --git a/starting_new_language.md b/starting_new_language.md new file mode 100644 index 00000000..2bca93c5 --- /dev/null +++ b/starting_new_language.md @@ -0,0 +1,20 @@ +## How to add a new language + +Things you need before: + + - Someone to be responsible + - Others to help out (and maybe also make responsible) + +## **In this repo** + +1. Create an issue "[Language] Localization summary". Copy the issue number. +1. Make a new label for the language +1. Go to `localize.json` and add your new language +1. Add the new owner to `CODEOWNERS` + +Send a PR with those changes, here's an example with French: [PR] + +## **In Discord** + +1. Create a new room: `#localize-[shortcode]` +1. Add the tag "localizer" to folks interested From 70433671e0f3a676c2cf39eb9b57f66354de6920 Mon Sep 17 00:00:00 2001 From: Orta Date: Thu, 22 Jul 2021 20:43:46 +0100 Subject: [PATCH 2/3] Adds PR reference --- starting_new_language.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/starting_new_language.md b/starting_new_language.md index 2bca93c5..5b9a5a8b 100644 --- a/starting_new_language.md +++ b/starting_new_language.md @@ -12,7 +12,7 @@ Things you need before: 1. Go to `localize.json` and add your new language 1. Add the new owner to `CODEOWNERS` -Send a PR with those changes, here's an example with French: [PR] +Send a PR with those changes, here's an example with French: [PR #101](https://github.com/microsoft/TypeScript-Website-Localizations/pull/101). ## **In Discord** From bb6ef17be2701ed18233e68993ab177bca99e86e Mon Sep 17 00:00:00 2001 From: Orta Date: Thu, 22 Jul 2021 20:58:29 +0100 Subject: [PATCH 3/3] Docs --- .github/CODEOWNERS | 10 +++++----- README.md | 2 +- welcome.md | 38 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 44 insertions(+), 6 deletions(-) create mode 100644 welcome.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 329c3901..5b4879a4 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -64,8 +64,8 @@ docs/typescriptlang/it.ts @Nabster101 @DeltaPy @PyGera [translation] [it] docs/documentation/it/**/*.md @Nabster101 @DeltaPy @PyGera [translation] [it] # Collaborators for French Translation of the Website -docs/playground/fr @ManuSquall [translation] [fr] -docs/tsconfig/fr/**/*.md @ManuSquall [translation] [fr] -docs/typescriptlang/fr/**/*.ts @ManuSquall [translation] [fr] -docs/typescriptlang/fr.ts @ManuSquall [translation] [fr] -docs/documentation/fr/**/*.md @ManuSquall [translation] [fr] +docs/playground/fr @ManuSquall @Ascor8522 [translation] [fr] +docs/tsconfig/fr/**/*.md @ManuSquall @Ascor8522 [translation] [fr] +docs/typescriptlang/fr/**/*.ts @ManuSquall @Ascor8522 [translation] [fr] +docs/typescriptlang/fr.ts @ManuSquall @Ascor8522 [translation] [fr] +docs/documentation/fr/**/*.md @ManuSquall @Ascor8522 [translation] [fr] diff --git a/README.md b/README.md index 4368974f..bd43a9fa 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ yarn lint yarn lint --watch ``` -That's it, you've got a copy of all the documentation and now can write documentation which follows the existing patterns. +That's it, you've got a copy of all the documentation and now can write documentation which follows the existing patterns. There's a longer intro [in `welcome.md`](./welcome.md). ### How translations work diff --git a/welcome.md b/welcome.md new file mode 100644 index 00000000..c25e5035 --- /dev/null +++ b/welcome.md @@ -0,0 +1,38 @@ +### Hello Translator + +Hey there someone looking at contributing to the TypeScript docs localization effort. This repo contains all of the non-English locale files. It means you can clone and translate without all the infrastructure overhead of the pretty complex TypeScript-Website. + +For each language there is a [Translation Summary issue](https://github.com/microsoft/TypeScript-Website-Localizations/issues?q=is%3Aissue+is%3Aopen+label%3A%22Translation+Summary%22) which is sort of the TODO per language. + +The website handles localization in a few different ways, but you can think of it as "if I can do it in lang x, otherwise english" for as much as possible. + +This means you can do _some_ localization and the site will work fine and only be partially translated. + +## Our Thanks + +Localization is important work, and having technical contributors who understand TypeScript helping out is a massive win for everyone. You're helping people to _not need_ to master English to program and that lowers barriers considerably. + +`<3` + +## The sections + +### `Documentation` + +This is the handbook pages, reference material and all the other pages you think of as "TypeScript Documentation". You create a file with the same name as the English, and it replaces the english with your language. + + +### `Playground` + +The code samples in the Playground are localized, and are a good starting place for a new language because they are pretty short and focused. + +### `TSConfig Reference` + +A chunky section covering all of the TSConfig file options. These are split into many markdown files, so you can quite easily do one or two at a time. + +### `TypeScript Lang` + +The 'bits of text' on the website, the glue between all of the website. Not _everything_ is in here. If something essential is missing bring it up in the localization channel in Discord. + +## Getting started + +Instructions in [the README](https://github.com/microsoft/TypeScript-Website-Localizations) show to get set up, and to run a validator that your changes are good! \ No newline at end of file