From fdc8b1ba72e516d871a46365003445205a20fcfd Mon Sep 17 00:00:00 2001 From: Eric Nakagawa Date: Tue, 24 Oct 2017 15:19:13 -0700 Subject: [PATCH] Add a link to the crowdin-cli download instructions --- docs/guides-translation.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/guides-translation.md b/docs/guides-translation.md index 0c891b88f0..101feeaa83 100644 --- a/docs/guides-translation.md +++ b/docs/guides-translation.md @@ -115,6 +115,8 @@ Create your translation project on [Crowdin](https://www.crowdin.com/). You can Your project will need a `crowdin.yaml` file generated. +> You will need to install `crowdin-cli`. Please follow the [installation directions](https://support.crowdin.com/cli-tool/). + The example below can be automatically generated by the docusaurus cli with the `examples` script. It should be placed in the top level of your project directory to configure how and what files are uploaded/downloaded. Below is an example crowdin configuration for the respective languages: German, Spanish, French, Japanese, Korean, Behasa Indonesia, Portuguese Brazilian, Chinese Simplified, and Chinese Traditional. @@ -150,8 +152,10 @@ You can add the following to your `package.json` to manually trigger crowdin. ```json "scripts": { - "crowdin-upload": "export CROWDIN_DOCUSAURUS_PROJECT_ID=$YOUR_CROWDIN_ID; export CROWDIN_DOCUSAURUS_API_KEY=$YOUR_CROWDIN_API_KEY; crowdin-cli --config ../crowdin.yaml upload sources --auto-update -b master", - "crowdin-download": "export CROWDIN_DOCUSAURUS_PROJECT_ID=$YOUR_CROWDIN_ID; export CROWDIN_DOCUSAURUS_API_KEY=$YOUR_CROWDIN_API_KEY; crowdin-cli --config ../crowdin.yaml download -b master" + "crowdin-upload": "export CROWDIN_DOCUSAURUS_PROJECT_ID=$YOUR_CROWDIN_ID; + export CROWDIN_DOCUSAURUS_API_KEY=$YOUR_CROWDIN_API_KEY; crowdin-cli --config ../crowdin.yaml upload sources --auto-update -b master", + "crowdin-download": "export CROWDIN_DOCUSAURUS_PROJECT_ID=$YOUR_CROWDIN_ID; + export CROWDIN_DOCUSAURUS_API_KEY=$YOUR_CROWDIN_API_KEY; crowdin-cli --config ../crowdin.yaml download -b master" }, ```