Skip to content

Commit 69341f6

Browse files
author
Orta Therox
authored
Merge pull request #101 from microsoft/adds_fr
Adds French language support
2 parents e4390f2 + bb6ef17 commit 69341f6

File tree

5 files changed

+70
-3
lines changed

5 files changed

+70
-3
lines changed

.github/CODEOWNERS

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,10 @@ docs/tsconfig/it/**/*.md @Nabster101 @DeltaPy @PyGera [translation] [it]
6262
docs/typescriptlang/it/**/*.ts @Nabster101 @DeltaPy @PyGera [translation] [it]
6363
docs/typescriptlang/it.ts @Nabster101 @DeltaPy @PyGera [translation] [it]
6464
docs/documentation/it/**/*.md @Nabster101 @DeltaPy @PyGera [translation] [it]
65+
66+
# Collaborators for French Translation of the Website
67+
docs/playground/fr @ManuSquall @Ascor8522 [translation] [fr]
68+
docs/tsconfig/fr/**/*.md @ManuSquall @Ascor8522 [translation] [fr]
69+
docs/typescriptlang/fr/**/*.ts @ManuSquall @Ascor8522 [translation] [fr]
70+
docs/typescriptlang/fr.ts @ManuSquall @Ascor8522 [translation] [fr]
71+
docs/documentation/fr/**/*.md @ManuSquall @Ascor8522 [translation] [fr]

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ yarn lint
2020
yarn lint --watch
2121
```
2222

23-
That's it, you've got a copy of all the documentation and now can write documentation which follows the existing patterns.
23+
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).
2424

2525
### How translations work
2626

localize.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
"id": 7,
1010
"uk": 8,
1111
"pl": 9,
12-
"it": 10
12+
"it": 10,
13+
"fr": 100
1314
},
1415
"docsRoots": [
1516
{ "name": "Playground", "from": "packages/playground-examples/copy/", "to": "docs/playground" },
@@ -25,7 +26,8 @@
2526
"docs/typescriptlang/pl/pl.ts",
2627
"docs/typescriptlang/pt/pt.ts",
2728
"docs/typescriptlang/vo/vo.ts",
28-
"docs/typescriptlang/zh/zh.ts"
29+
"docs/typescriptlang/zh/zh.ts",
30+
"docs/typescriptlang/fr/fr.ts"
2931
]
3032
}
3133
}

starting_new_language.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## How to add a new language
2+
3+
Things you need before:
4+
5+
- Someone to be responsible
6+
- Others to help out (and maybe also make responsible)
7+
8+
## **In this repo**
9+
10+
1. Create an issue "[Language] Localization summary". Copy the issue number.
11+
1. Make a new label for the language
12+
1. Go to `localize.json` and add your new language
13+
1. Add the new owner to `CODEOWNERS`
14+
15+
Send a PR with those changes, here's an example with French: [PR #101](https://github.com/microsoft/TypeScript-Website-Localizations/pull/101).
16+
17+
## **In Discord**
18+
19+
1. Create a new room: `#localize-[shortcode]`
20+
1. Add the tag "localizer" to folks interested

welcome.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
### Hello Translator
2+
3+
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.
4+
5+
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.
6+
7+
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.
8+
9+
This means you can do _some_ localization and the site will work fine and only be partially translated.
10+
11+
## Our Thanks
12+
13+
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.
14+
15+
`<3`
16+
17+
## The sections
18+
19+
### `Documentation`
20+
21+
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.
22+
23+
24+
### `Playground`
25+
26+
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.
27+
28+
### `TSConfig Reference`
29+
30+
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.
31+
32+
### `TypeScript Lang`
33+
34+
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.
35+
36+
## Getting started
37+
38+
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!

0 commit comments

Comments
 (0)