Transifex Sync is a Zendesk app that synchronizes your Help Center content and finished translations between Zendesk and Transifex. This guide will walk you through the process of installing and using Transifex Sync:
- Setting up a project in Transifex
- Installing Transifex Sync
- Configuring your Zendesk Help Center to support multiple languages
- Sending content to Transifex
- Translating content
- Getting translations
- Translate updated content
- Refresh button
To use Transifex Sync, you’ll need to be on Zendesk’s Professional or Enterprise plan, as only those plans support multilingual content.
Before you can translate your Zendesk Help Center, you'll first need a project in Transifex for storing your Zendesk content and translations. To create a project, head to your Transifex Dashboard and click Create new project. Then follow the steps on the page to create your project.
When creating the project, be sure to:
- Choose File-based Project when picking a project type.
- Select source and target langauges that are supported by Zendesk.
Once you’ve set up your project, you can install Transifex Sync from the Zendesk App Marketplace:
Head to your Zendesk agent (the URL should look something like this: https://yourcompany.zendesk.com/agent/).
Click on the Gear icon in the left menu to go to the Admin area.
Under APPS, click on Marketplace.
In the search box, type Transifex.
Click on the Transifex app icon.
Click Install app.
Enter your Transifex username and password (alternatively, you can use
apias your username and your API token as the password). Then enter the URL for Transifex project you created earlier. When adding your project URL, be sure to include the https://. The URL should look something like https://www.transifex.com/company/zendesk-help-center/.
Hit Install to finish the installation process.
By default, your Zendesk Help Center only supports one language. You have to configure it to support additional languages. There are two places you have to do this: the Support Agent, and the Help Center.
From your Zendesk Agent, click on the Gear icon to go back to the Admin area.
Under SETTINGS, select Account, then click on the Localization tab.
Set your default language from the dropdown. This should be the same as the source language you set for your project in Transifex.
Click Additional languages and select the languages you want to offer your Help Center in. They should match the target languages you chose when you created your project earlier.
Click Save tab.
Next, we’ll repeat the same setup inside the Help Center:
From the top menu bar of the Agent, click on the windows/grid icon on the right. Then click on Help Center.
In the top menu bar of the Help Center, click on General > Help Center settings.
At the bottom of the page, in the Languages section, select the same set of languages as before.
Hit Update at the top of the page to save your settings.
Now that you’ve set up a project and enabled multilingual support in your Help Center, you’re ready to start using Transifex Sync!
Navigate back to your Zendesk Agent and click the Tx icon in the sidebar to enter Transifex Sync. There, you’ll see content from your articles, sections, categories, and dynamic content separated into individual tabs.
Ensure translated articles are viewable
For any translated article to be viewable in your Help Center, the name of the section and category it belongs to must be translated as well. You can learn more about this requirement in this Zendesk article.
To send content to Transifex for translation:
Click on the tab corresponding to the type of content you want to translate. (For simplicity’s sake, we’ll only mention articles going forward. However, the process is the same for sections, categories, and dynamic content.)
Use the checkboxes to select the articles you want to send to Transifex.
Click the Send content button.
Each article you upload will be added to Transifex as an individual HTML file (resource). You can quickly jump right to that article in Transifex by clicking on the Resource link in the Transifex Sync app.
Once your content is inside Transifex, you have a number of translation options:
- Invite your translation agency or in-house team to work in Transifex using the Editor.
- Order translations from Transifex partners. The finished translations are delivered back to you inside Transifex.
- Crowdsource translations with your community.
- Machine translate using Google Translate or Bing Translator.
When translations for an article are finished, you’ll need to get them into Zendesk from Transifex in order to use them. The steps for doing so are similar to those you took to send content to Transifex
In Transifex Sync, select the articles you want to get translations for.
Click the Get Translations button.
This saves translations from Transifex to Zendesk.
You can get translations for an article as soon as it’s 100% translated in a language. The Completed Translations column in Transifex Sync shows you which languages are 100% translated for a resource.
The next time a user visits your Help Center, they’ll see a language switcher in the navigation menu.
Whenever you update an article, you can follow the same steps as before to translate the changed content. The only difference is that when you click the “Send content” button, the existing HTML file in Transifex will be updated. New content is added to the file. Deleted content is removed. And unchanged content, along with their translations, will be preserved. You only have to translate the new content. More information about how Transifex handles file updates can be found here.
If you have new Help Center content, but you’re not seeing it in Transifex Sync, click the Refresh link at the top right. This triggers a check in Zendesk and Transifex for new content.
If you have multiple brands in Zendesk, you can use Transifex Sync to translate the help center of each brand. Setting up additional brands for translation works a little differently than that of setting up the first (primary) brand because the content from each brand will live in its own project in Transifex. Assuming you’ve followed the steps above to translate your primary brand, here’s how you can translate additional brands. There are two steps to this process.
Add a Zendesk API token to the app configuration
Follow the instructions here to generate a new Zendesk API token. Copy the token to your clipboard, you’ll need it later.
From the Zendesk the Admin, go to the APPS section and click Manage.
Click on the Transifex app icon and go to the App Configuration tab.
Paste the API token you copied into the Zendesk API key field.
Hit Save Settings.
Create a new project for the brand you’re translating
Return to the Transifex Sync app.
Click on the Select Brand dropdown in the right and hit Translate another brand. This will take you to a different page where you’ll create a new project in Transifex for the brand you want to translate.
From the dropdown, select which brand you want to translate, then give the project a name (you can change this name in Transifex later). On this page, you’ll also see the languages the selected brand’s help center has been set up for.
Hit Create Transifex project when done.
You’ll be taken back to the article list view. From there, you can send content and get translations like you did before.
While you can change the name of the Transifex project you created, you should leave the project URL (project slug) as is. Changing the project URL will break the connection between Zendesk and Transifex, making it impossible to send content and get translations.