[GitHub] [pulsar] Jennifer88huang commented on issue #4133: [website] Add instructions on how to download translated docs

[GitBox <gi...@apache.org>]

Jennifer88huang commented on issue #4133: [website] Add instructions on how to download translated docs
URL: https://github.com/apache/pulsar/pull/4133#issuecomment-486703148
 
 
   It's great to add such useful information, yet contributors could not download or debug issues since they have no access to the API keys.
   Maybe you could write the instructions like this:
   
   ### Download Translated Docs
   
   When you find display issues on the translated pages, you can download the translated docs from Crowdin, and follow the instructions below to debug and fix issues.
   
   1. Install Crowdin CLI
   
   To download the translated markdown files, you need to install [Crowdin CLI](https://support.crowdin.com/cli-tool/#installation) first.
   
   2. Set environment variables
   
   You need to set the following environment variables:
   
   ```
   export CROWDIN_DOCUSAURUS_PROJECT_ID="apache-pulsar"
   export CROWDIN_DOCUSAURUS_API_KEY=<crowdin-pulsar-api-key>
   ```
   
   You can find the API Key of Pulsar Crowdin project [here](https://crowdin.com/project/apache-pulsar/settings#api). Only PMC members and
   committers are able to retrieve the API key.
   
   3. Download the translated docs
   
   Now you are ready to download the translated docs from Crowdin.
   
   ```
   $ cd ${PULSAR_HOME}/site2/website
   # download all translated docs
   $ yarn crowdin-download
   # download the translated docs for `zh-CN`
   $ yarn crowdin-download -l zh-CN
   ```
   
   The translated docs are downloaded in the directory `site2/website/translated_docs`.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services