Skip to content

Commit bb6ef17

Browse files
committed
Docs
1 parent 7043367 commit bb6ef17

File tree

3 files changed

+44
-6
lines changed

3 files changed

+44
-6
lines changed

.github/CODEOWNERS

+5-5
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ docs/typescriptlang/it.ts @Nabster101 @DeltaPy @PyGera [translation] [it]
6464
docs/documentation/it/**/*.md @Nabster101 @DeltaPy @PyGera [translation] [it]
6565

6666
# Collaborators for French Translation of the Website
67-
docs/playground/fr @ManuSquall [translation] [fr]
68-
docs/tsconfig/fr/**/*.md @ManuSquall [translation] [fr]
69-
docs/typescriptlang/fr/**/*.ts @ManuSquall [translation] [fr]
70-
docs/typescriptlang/fr.ts @ManuSquall [translation] [fr]
71-
docs/documentation/fr/**/*.md @ManuSquall [translation] [fr]
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

+1-1
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

welcome.md

+38
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)