With the Zendesk integration, you can synchronize your Help Center content with translations in Transifex. With Context for Files (CFF), you can link Transifex with one or more websites in order to highlight translations within your site to get the visual context that is helpful for translators.
Using Zendesk and CFF in conjunction with each other provides a powerful workflow for verifying that translations are both correct and ensuring that those translations will look good on the page before they're published.
The workflow outlined below demonstrates how to:
Create a draft article in Zendesk
Sync the article with Transifex
Translate the article in Transifex
Review translations in Transifex, marking them as reviewed
Make use of Context for Files in Transifex to see how the translations appear in the Zendesk article before going live
Mark finalized translations as Proofread in Transifex
Sync the translations with Zendesk
Publish the article in Zendesk
Steps for enabling this workflow:
Before enabling this workflow, you will first need to...
Configure the Zendesk integration at the Organization level.
Turn on Context for Files - Add the CFF javascript snippet to a page in the active Theme in Zendesk (e.g. the footer.hbs file). Just click the
Customizebutton for the Active/Live theme, then click theEdit codebutton...
Create a new Article in Zendesk and Save it (not published).
(If not already done, in an existing or new file-based project in Transifex, configure the Zendesk integration at the Project level. If this is the first time the Zendesk integration is run at the project level, then the button for the Select Content wizard step will say
Nextinstead ofUpdate Settings & Synchronize.)
Update the Zendesk integration Settings by checking the box next to the new draft article, then click the Update Settings & Synchronize button.
Please note that CFF will work regardless of the selection for the Push Translations option in the last step of the wizard. So, whatever you decide to select there is completely up to whatever best suits your desired workflow. In the specific example, we consider proofread step as the final step for translation approval so we chose to automatically sync translations with Zendesk only when translations are proofread (2nd review step enabled).
In Transifex, click the
Translatebutton for that article/resource to get to the Editor and make the translations.A reviewer for the project in Transifex verifies the translations and marks them as Reviewed.
Wait (up to) 1 hour, then visit the page via the Preview in Help Center link in Zendesk to trigger the CFF functionality (It’s possible that CFF will be available earlier than 1 hour, but that is the max time to wait in order for the page to be visited, and therefore for the CFF javascript snippet to be able to run, for it to work.)
A Quality Assurance or other designated person verifies the translations using CFF, and, if everything looks OK, marks the translations as Proofread in Transifex; depending on the visibility of the article in Zendesk, this person may need appropriate permissions in Zendesk.
Note that if the CFF eye icon is greyed out, then CFF needs more time before visiting the page again. If the string is found in more than 1 place, then a link to each will be displayed in the list.
Clicking on the link in the CFF dialog window will open the page in Zendesk and show the string translated into the selected target language in the Transifex Editor (highlighted in green).
Sync the translations for the article back with Zendesk. Depending on the configuration, this will either happen automatically or you can use the Send to Zendesk link to perform a manual sync.
Publish the article in Zendesk.
Sit back with confidence knowing that the article will be translated accurately and look great!
This guide showed how to use the Zendesk integration in conjunction with Context for Files (CFF) to demonstrate the value that comes from using both in a typical workflow.
Continue Reading