Introduction

The TranslationOS connector for GitHub allows you to outsource the professional translation of your string resources and documents to Translated, with no need to manually import and export content or switch between tools.

This connector can be configured to be event- or polling-based, meaning it can be triggered by specific actions or set up to fetch content at intervals. To learn which actions trigger the connector, see the section Requesting translations.

Support

For general questions about functionality, our dedicated support team can be reached at [email protected].

If you need technical information or you’re ready to integrate GitHub with TranslationOS, feel free to reach out to us at [email protected] for assistance with onboarding.

The onboarding process may vary depending on your needs, but the following steps are a helpful guideline:

  1. You will agree with Translated on the required service levels, also known as service types.
  2. Translated will analyse your files and build any custom parsers required.
  3. You will install the connector app in your GitHub repository.
  4. Translated will help you set up projects and filesets—including custom parsers, pluralisation handling and URL pre-processing—and configure the fetching and delivery methods.
  5. We will be ready to receive, process and deliver your translation requests!

Setting up the connector

The first step is to analyse your files and determine whether custom parsers are required. Once any custom parsers have been built, you will need to install an app in your GitHub repository. With that done, we will work with you to set up projects and filesets, and to configure the fetching and delivery methods.

Analysing your files

TranslationOS natively supports a wide range of file types. See the content_type field of the /translate endpoint.

If your files make use of an unsupported standardised structure or custom structure, we will need to build a custom parser for you. See here for the custom parsers that are currently supported.

Installing the GitHub app

Translated will provide you with a link to the connector’s GitHub app. You will need to install it and grant it the required permissions. The app will install a webhook subscribed to push events.

Creating projects