Add Localization Support for Jest Website (jestjs#3416)

* Adds a link to CrowdIn project from language drop down * Adds comments to generated files * Modify Circle CI to manually download crowdin cli * Doc build process only renders pages that are enabled in languages.js * Added a favicon.ico * Merging TutorialAsync.md Adding Bosnian, enabling Espanol Using ENV variables
acamposruiz · May 2, 2017 · 62d29f2 · 62d29f2
1 parent 909da52
commit 62d29f2
Show file tree

Hide file tree

Showing 65 changed files with 1,765 additions and 424 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -8,5 +8,6 @@ types/**
 website/build
 website/node_modules
 website/core/metadata*.js
+website/i18n/*.js
 website/src/jest/docs
 website/src/jest/blog
diff --git a/.gitignore b/.gitignore
@@ -4,10 +4,13 @@
 *~
 /danger/node_modules/
 /examples/*/node_modules/
+
 /integration_tests/*/node_modules
 /integration_tests/transform/*/coverage
 /integration_tests/transform/*/node_modules
+
 /node_modules
+
 /packages/*/build/
 /packages/*/coverage/
 /packages/*/node_modules/
@@ -17,6 +20,47 @@
 /website/src/jest/blog
 /website/src/jest/docs
 /website/yarn.lock
+
+/website/i18n/*
+!/website/i18n/en.json
+
+/website/af
+/website/ar
+/website/ca
+/website/cs
+/website/da
+/website/de
+/website/el
+/website/es-ES
+/website/fa-IR
+/website/fi
+/website/fr
+/website/he
+/website/hu
+/website/id-ID
+/website/it
+/website/ja
+/website/ko
+/website/mr-IN
+/website/nl
+/website/no-NO
+/website/pl
+/website/pt-BR
+/website/pt-PT
+/website/ro
+/website/ru
+/website/sk-SK
+/website/sr
+/website/sv-SE
+/website/tr
+/website/uk
+/website/vi
+/website/zh-Hans
+/website/zh-Hant
+
+/docs/*
+!/docs/en
+
 coverage
 lerna-debug.log
 npm-debug.log

diff --git a/README.md b/README.md
@@ -42,8 +42,10 @@ test('adds 1 + 2 to equal 3', () => {
 Add the following section to your `package.json`:
 
 ```json
-"scripts": {
-  "test": "jest"
+{
+  "scripts": {
+    "test": "jest"
+  }
 }
 ```
 

diff --git a/circle.yml b/circle.yml
@@ -42,4 +42,11 @@ deployment:
       - git config --global user.email "jest-bot@users.noreply.github.com"
       - git config --global user.name "Website Deployment Script"
       - echo "machine github.com login jest-bot password $GITHUB_TOKEN" > ~/.netrc
+      # WEBSITE DEPLOY
+      - sudo apt-get install default-jre
+      - wget https://artifacts.crowdin.com/repo/deb/crowdin.deb -O crowdin.deb
+      - sudo dpkg -i crowdin.deb
+      # crowdin install end
+      - crowdin --config crowdin.yaml upload sources --auto-update -b master
+      - crowdin --config crowdin.yaml download -b master
       - cd website && GIT_USER=jest-bot npm run gh-pages
diff --git a/crowdin.yaml b/crowdin.yaml
@@ -0,0 +1,48 @@
+project_identifier_env: CROWDIN_PROJECT_ID
+api_key_env: CROWDIN_API_KEY
+base_path: "./"
+
+files:
+  -
+    source: '/docs/en/*.md'
+    translation: '/docs/%locale%/%original_file_name%'
+    languages_mapping: &anchor
+      locale:
+        'af': 'af'
+        'ar': 'ar'
+        'bs-BA': 'bs-BA'
+        'ca': 'ca'
+        'cs': 'cs'
+        'da': 'da'
+        'de': 'de'
+        'el': 'el'
+        'es-ES': 'es-ES'
+        'fa': 'fa-IR'
+        'fi': 'fi'
+        'fr': 'fr'
+        'he': 'he'
+        'hu': 'hu'
+        'id': 'id-ID'
+        'it': 'it'
+        'ja': 'ja'
+        'ko': 'ko'
+        'mr': 'mr-IN'
+        'nl': 'nl'
+        'no': 'no-NO'
+        'pl': 'pl'
+        'pt-BR': 'pt-BR'
+        'pt-PT': 'pt-PT'
+        'ro': 'ro'
+        'ru': 'ru'
+        'sk': 'sk-SK'
+        'sr': 'sr'
+        'sv-SE': 'sv-SE'
+        'tr': 'tr'
+        'uk': 'uk'
+        'vi': 'vi'
+        'zh-CN': 'zh-Hans'
+        'zh-TW': 'zh-Hant'
+  -
+    source: '/website/i18n/en.json'
+    translation: '/website/i18n/%locale%.json'
+    languages_mapping: *anchor
diff --git a/docs/CLI.md → docs/en/CLI.md b/docs/CLI.md → docs/en/CLI.md
@@ -1,9 +1,9 @@
 ---
 id: cli
 title: Jest CLI Options
-layout: reference
+layout: docs
 category: API Reference
-permalink: docs/cli.html
+permalink: docs/en/cli.html
 previous: configuration
 ---
 

diff --git a/docs/Configuration.md → docs/en/Configuration.md b/docs/Configuration.md → docs/en/Configuration.md
@@ -1,9 +1,9 @@
 ---
 id: configuration
 title: Configuring package.json
-layout: reference
+layout: docs
 category: API Reference
-permalink: docs/configuration.html
+permalink: docs/en/configuration.html
 previous: jest-object
 next: cli
 ---

diff --git a/docs/ExpectAPI.md → docs/en/ExpectAPI.md b/docs/ExpectAPI.md → docs/en/ExpectAPI.md
@@ -1,9 +1,9 @@
 ---
 id: expect
 title: Expect
-layout: reference
+layout: docs
 category: API Reference
-permalink: docs/expect.html
+permalink: docs/en/expect.html
 previous: api
 next: mock-function-api
 ---

diff --git a/docs/GettingStarted.md → docs/en/GettingStarted.md b/docs/GettingStarted.md → docs/en/GettingStarted.md
@@ -3,7 +3,7 @@ id: getting-started
 title: Getting Started
 layout: docs
 category: Introduction
-permalink: docs/getting-started.html
+permalink: docs/en/getting-started.html
 next: using-matchers
 ---
 

diff --git a/docs/GlobalAPI.md → docs/en/GlobalAPI.md b/docs/GlobalAPI.md → docs/en/GlobalAPI.md
@@ -1,9 +1,9 @@
 ---
 id: api
 title: Globals
-layout: reference
+layout: docs
 category: API Reference
-permalink: docs/api.html
+permalink: docs/en/api.html
 next: expect
 ---
 

diff --git a/docs/JestObjectAPI.md → docs/en/JestObjectAPI.md b/docs/JestObjectAPI.md → docs/en/JestObjectAPI.md
@@ -1,9 +1,9 @@
 ---
 id: jest-object
 title: The Jest Object
-layout: reference
+layout: docs
 category: API Reference
-permalink: docs/jest-object.html
+permalink: docs/en/jest-object.html
 previous: mock-function-api
 next: configuration
 ---

diff --git a/docs/ManualMocks.md → docs/en/ManualMocks.md b/docs/ManualMocks.md → docs/en/ManualMocks.md
@@ -3,7 +3,7 @@ id: manual-mocks
 title: Manual Mocks
 layout: docs
 category: Guides
-permalink: docs/manual-mocks.html
+permalink: docs/en/manual-mocks.html
 previous: timer-mocks
 next: webpack
 ---

diff --git a/docs/MigrationGuide.md → docs/en/MigrationGuide.md b/docs/MigrationGuide.md → docs/en/MigrationGuide.md
@@ -3,7 +3,7 @@ id: migration-guide
 title: Migrating to Jest
 layout: docs
 category: Guides
-permalink: docs/migration-guide.html
+permalink: docs/en/migration-guide.html
 previous: webpack
 next: testing-frameworks
 ---
@@ -30,4 +30,4 @@ To transform your existing tests, navigate to the project containing the tests a
 jest-codemods
 ```
 
-More information can be found at https://github.com/skovhus/jest-codemods.
+More information can be found at https://github.com/skovhus/jest-codemods.
diff --git a/docs/MockFunctionAPI.md → docs/en/MockFunctionAPI.md b/docs/MockFunctionAPI.md → docs/en/MockFunctionAPI.md
@@ -1,9 +1,9 @@
 ---
 id: mock-function-api
 title: Mock Functions
-layout: reference
+layout: docs
 category: API Reference
-permalink: docs/mock-function-api.html
+permalink: docs/en/mock-function-api.html
 previous: expect
 next: jest-object
 ---

diff --git a/docs/MockFunctions.md → docs/en/MockFunctions.md b/docs/MockFunctions.md → docs/en/MockFunctions.md
@@ -3,7 +3,7 @@ id: mock-functions
 title: Mock Functions
 layout: docs
 category: Introduction
-permalink: docs/mock-functions.html
+permalink: docs/en/mock-functions.html
 previous: setup-teardown
 next: more-resources
 ---

diff --git a/docs/MoreResources.md → docs/en/MoreResources.md b/docs/MoreResources.md → docs/en/MoreResources.md
@@ -3,7 +3,7 @@ id: more-resources
 title: More Resources
 layout: docs
 category: Introduction
-permalink: docs/more-resources.html
+permalink: docs/en/more-resources.html
 previous: mock-functions
 next: snapshot-testing
 ---

diff --git a/docs/SetupAndTeardown.md → docs/en/SetupAndTeardown.md b/docs/SetupAndTeardown.md → docs/en/SetupAndTeardown.md
@@ -3,7 +3,7 @@ id: setup-teardown
 title: Setup and Teardown
 layout: docs
 category: Introduction
-permalink: docs/setup-teardown.html
+permalink: docs/en/setup-teardown.html
 previous: asynchronous
 next: mock-functions
 ---

diff --git a/docs/SnapshotTesting.md → docs/en/SnapshotTesting.md b/docs/SnapshotTesting.md → docs/en/SnapshotTesting.md
@@ -3,7 +3,7 @@ id: snapshot-testing
 title: Snapshot Testing
 layout: docs
 category: Guides
-permalink: docs/snapshot-testing.html
+permalink: docs/en/snapshot-testing.html
 next: tutorial-react
 ---
 

diff --git a/docs/TestingAsyncCode.md → docs/en/TestingAsyncCode.md b/docs/TestingAsyncCode.md → docs/en/TestingAsyncCode.md
@@ -3,7 +3,7 @@ id: asynchronous
 title: Testing Asynchronous Code
 layout: docs
 category: Introduction
-permalink: docs/asynchronous.html
+permalink: docs/en/asynchronous.html
 previous: using-matchers
 next: setup-teardown
 ---

diff --git a/docs/TestingFrameworks.md → docs/en/TestingFrameworks.md b/docs/TestingFrameworks.md → docs/en/TestingFrameworks.md
diff --git a/docs/TimerMocks.md → docs/en/TimerMocks.md b/docs/TimerMocks.md → docs/en/TimerMocks.md
@@ -3,7 +3,7 @@ id: timer-mocks
 title: Timer Mocks
 layout: docs
 category: Guides
-permalink: docs/timer-mocks.html
+permalink: docs/en/timer-mocks.html
 previous: tutorial-async
 next: manual-mocks
 ---

diff --git a/docs/Troubleshooting.md → docs/en/Troubleshooting.md b/docs/Troubleshooting.md → docs/en/Troubleshooting.md
@@ -3,8 +3,10 @@ id: troubleshooting
 title: Troubleshooting
 layout: docs
 category: Guides
-permalink: docs/troubleshooting.html
+permalink: docs/en/troubleshooting.html
 previous: testing-frameworks
+next: api
+
 ---
 
 Uh oh, something went wrong? Use this guide to resolve issues with Jest.

diff --git a/docs/TutorialAsync.md → docs/en/TutorialAsync.md b/docs/TutorialAsync.md → docs/en/TutorialAsync.md
@@ -3,7 +3,7 @@ id: tutorial-async
 title: An Async Example
 layout: docs
 category: Guides
-permalink: docs/tutorial-async.html
+permalink: docs/en/tutorial-async.html
 previous: tutorial-react-native
 next: timer-mocks
 ---

diff --git a/docs/TutorialReact.md → docs/en/TutorialReact.md b/docs/TutorialReact.md → docs/en/TutorialReact.md
@@ -3,7 +3,7 @@ id: tutorial-react
 title: Testing React Apps
 layout: docs
 category: Guides
-permalink: docs/tutorial-react.html
+permalink: docs/en/tutorial-react.html
 previous: snapshot-testing
 next: tutorial-react-native
 ---

diff --git a/docs/TutorialReactNative.md → docs/en/TutorialReactNative.md b/docs/TutorialReactNative.md → docs/en/TutorialReactNative.md
@@ -3,7 +3,7 @@ id: tutorial-react-native
 title: Testing React Native Apps
 layout: docs
 category: Guides
-permalink: docs/tutorial-react-native.html
+permalink: docs/en/tutorial-react-native.html
 previous: tutorial-react
 next: tutorial-async
 ---

diff --git a/docs/TutorialWebpack.md → docs/en/TutorialWebpack.md b/docs/TutorialWebpack.md → docs/en/TutorialWebpack.md
@@ -2,6 +2,6 @@
 id: tutorial-webpack
 title: webpack
 layout: redirect
-permalink: docs/tutorial-webpack.html
+permalink: docs/en/tutorial-webpack.html
 destinationUrl: webpack.html
 ---
diff --git a/docs/TutorialjQuery.md → docs/en/TutorialjQuery.md b/docs/TutorialjQuery.md → docs/en/TutorialjQuery.md
@@ -3,7 +3,7 @@ id: tutorial-jquery
 title: DOM Manipulation
 layout: docs
 category: Guides
-permalink: docs/tutorial-jquery.html
+permalink: docs/en/tutorial-jquery.html
 next: mock-functions
 ---
 

diff --git a/docs/UsingMatchers.md → docs/en/UsingMatchers.md b/docs/UsingMatchers.md → docs/en/UsingMatchers.md
@@ -3,7 +3,7 @@ id: using-matchers
 title: Using Matchers
 layout: docs
 category: Introduction
-permalink: docs/using-matchers.html
+permalink: docs/en/using-matchers.html
 previous: getting-started
 next: asynchronous
 ---

diff --git a/docs/Webpack.md → docs/en/Webpack.md b/docs/Webpack.md → docs/en/Webpack.md
@@ -3,7 +3,7 @@ id: webpack
 title: Using with webpack
 layout: docs
 category: Guides
-permalink: docs/webpack.html
+permalink: docs/en/webpack.html
 previous: manual-mocks
 next: migration-guide
 ---