Merge branch 'main' of https://github.com/microsoft/TypeScript-Website-Localizations into main

Author: fegerar

.github/workflows/CI.yml

@@ -0,0 +1,57 @@
+name: CI
+on: pull_request
+
+jobs:
+  local-validate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+      - run: yarn
+      - run: yarn docs-sync validate-against-en
+
+  site-builds:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "13.x"
+
+      # Clone this PR, and setup the deps
+      - uses: actions/checkout@v1
+      - run: yarn
+
+      # Clone the TS website, basically:
+      # git clone https://github.com/microsoft/TypeScript-Website website
+      - name: Checkout tools repo
+        uses: actions/checkout@v2
+        with:
+          repository: microsoft/TypeScript-Website
+          path: website
+
+      # Both the microsoft/TypeScript-Website & 1 - don't really need to be there, but 
+      # this migrates the translated docs into the website
+      - run: yarn docs-sync pull microsoft/TypeScript-Website 1 --from-cwd . --to-cwd website
+
+      # Get dependencies for building the ebooks
+      - run: sudo apt-get update
+      - run: sudo apt install calibre
+
+      - run: yarn install
+        env:
+          YARN_CHECKSUM_BEHAVIOR: ignore
+        working-directory: ./website
+
+
+      # Verify the website build
+      - run: yarn bootstrap
+        working-directory: ./website
+
+      - run: yarn workspace typescriptlang-org build
+        working-directory: ./website
+
+      # Verify the website build
+      - run: yarn test
+        working-directory: ./website

.github/workflows/codeowners-merge.yml

@@ -0,0 +1,16 @@
+name: Codeowners merging
+on:
+  pull_request_target: { types: opened }
+  issue_comment: { types: created }
+  pull_request_review: { types: submitted }
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Run Codeowners merge check
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: OSS-Docs-Tools/code-owner-self-merge@master

.github/workflows/post-localizations.yml

@@ -0,0 +1,18 @@
+on:
+  pull_request_target:
+    types: [assigned, opened, synchronize, reopened]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+      - run: yarn install
+
+      - run: yarn danger ci
+        env:
+          DEBUG: "*"
+          DANGER_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          AZURE_TRANSLATE_KEY: ${{ secrets.AZURE_TRANSLATE_KEY }}

.github/workflows/weekly.yml

@@ -0,0 +1,23 @@
+name: Weekly issue updates
+
+on:
+  schedule:
+    # https://crontab.guru/#0_12_*_*_1
+    - cron: "0 12 * * 1"
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+      - run: yarn install
+        env:
+          YARN_CHECKSUM_BEHAVIOR: ignore
+
+      # Update all the translation issues on a nightly basis
+      - run: yarn docs-sync update-github-issues microsoft/TypeScript-Website-Localizations
+        env:
+          GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -2,7 +2,7 @@
 
 A repo for handling localized versions of the TypeScript website content
 
-### How this works
+### Setting up
 
 ```sh
 git clone https://github.com/microsoft/TypeScript-Website-Localizations
@@ -11,14 +11,56 @@ cd TypeScript-Website-Localizations
 # Setup
 yarn
 
-# Optional: Grab the English files
+# Optional: Grab the English files to make translation easier
 yarn pull-en
+
+# Optional: Verify your changes will correctly replace the english files
+yarn validate-paths
 ```
 
 That's it, you've got a copy of all the documentation and now can write documentation which follows the existing patterns.
 
-More docs to come.
+### How translations work 
+
+The TypeScript website handles translations by having language specific files with matching filepaths:
+
+E.g: [`/packages/documentation/copy/en/reference/JSX.md`](https://github.com/microsoft/TypeScript-website/blob/68a4f67ed5f396228eeb6d0309b51bcfb19d31a1/packages/documentation/copy/en/reference/JSX.md#L1)
+
+Has existing translations in different languages:
+
+```sh
+/packages/documentation/copy/id/reference/JSX.md
+/packages/documentation/copy/ja/reference/JSX.md
+/packages/documentation/copy/pt/reference/JSX.md
+```
+
+Same path, just switched `en` for `id`, `ja` & `pt`.
+
+#### This repo
+
+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 example if you wanted to translate a new handbook page you would:
+
+- Clone this repo (see above)
+- Pull in the English files `yarn pull-en` (these will be gitignored)
+- Find your english file: `docs/documentation/en/handbook-v2/Basics.md`
+- Recreate the same folder path in your language: `docs/documentation/it/handbook-v2/Basics.md`
+- Translate the file! 
+- Create a pull request to this repo
+- Once merged, the translation will appear on the next website deploy
+
+#### Language owners
+
+When a new language is created, we ask for a few people to become language owners. These owners are able to merge pull requests to files in their language via [code-owner-self-merge](https://github.com/OSS-Docs-Tools/code-owner-self-merge) in a pull request. They will be pinged on PRs which affect them, you can see the flow in PRs like [this](https://github.com/microsoft/TypeScript-Website/pull/1478) or [this](https://github.com/microsoft/TypeScript-Website/pull/1458).
+
+The TypeScript team generally only know English, and can answer clarifying questions if needed! For quick questions, you can use the `ts-website-translation` channel in the [TypeScript Discord](https://discord.gg/typescript).
+
+#### Well tested
+
+This repo has extensive CI to ensure that you can't accidentally break the TypeScript website. 
 
+There are local, fast checks that it won't break via `yarn test` and then the full TypeScript website test suite runs with the changes, and a website build is generated to ensure that nothing breaks.
 
 # Contributing
 

dangerfile.ts

@@ -0,0 +1,21 @@
+const markdownTranslate = require('@orta/markdown-translator')
+import {danger, message} from "danger"
+
+const go = async () => {
+  const allMDFiles = [...danger.git.modified_files, ...danger.git.created_files].filter(f => f.endsWith(".md")).filter(f => f.split("/").length > 2)
+  console.log(allMDFiles)
+  for (const file of allMDFiles) {
+    const fileContents = await danger.github.utils.fileContents(file)
+    const translation = await markdownTranslate({
+      text: fileContents,
+      from: file.split("/")[2],
+      to: "en",
+      subscriptionKey: process.env.AZURE_TRANSLATE_KEY,
+      region: "eastus"
+    })
+    
+    message(`## Translation of ${danger.github.utils.fileLinks([file])}\n\n${translation}`)
+  };
+}
+
+go()

docs/documentation/ko/tutorials/Babel with TypeScript.md

@@ -40,7 +40,7 @@ Babel 사용의 단점은 TS를 JS로 전환하는 동안 타입 검사를 할 
   "emitDeclarationOnly": true,
   // Babel이 TypeScript 프로젝트의 파일을 안전하게 트랜스파일할 수 있는지 확인합니다.
   "isolatedModules": true
-}
+} 
 ```
 
 해당 플래그에 대한 자세한 내용은 다음을 참고해주세요:

docs/documentation/ko/tutorials/React.md

@@ -24,3 +24,5 @@ TypeScript는 [JSX](/docs/handbook/jsx.html)를 지원하며 `useState`와 같
 
 - [React TypeScript Cheatsheets](https://react-typescript-cheatsheet.netlify.app)
 - [React & Redux in TypeScript](https://github.com/piotrwitek/react-redux-typescript-guide#react--redux-in-typescript---complete-guide)
+
+

docs/documentation/ko/tutorials/TypeScript Tooling in 5 minutes.md

@@ -172,6 +172,7 @@ TypeScript의 클래스는 JavaScript에서 자주 사용되는 동일한 프로
 </html>
 ```
 
+
 브라우저에서 `greeter.html`을 열어 첫 번째 간단한 TypeScript 웹 애플리케이션을 실행하세요!
 
 추가로: Visual Studio에서 `greeter.ts`를 열거나, TypeScript playground에 코드를 복사해보세요.