Skip to main content

Integrating with Quetzal

Once your codebase is linked with Quetzal, we can begin delivering localization updates via source control.

Prerequisites

Quetzal currently only supports repositories hosted on GitHub. Verify that your stack is supported by reading our supported stacks.

Linking a Repository

Once you’ve signed up, you can link a repository You will be prompted to install the Quetzal GitHub app to grant access to one or more repositories. Once installed, you will be prompted to select one to complete the installation with.

Selecting Directory

You will be prompted to scope the Quetzal integration to specific directories. If you have a repo with multiple distinct localization patterns (ie, a monorepo) it is best to set up multiple integrations in the same repo with directories which do not overlap. If your repository only has the same localization patterns throughout, you can leave this blank.

Defining Locales

You will be prompted to define which locales you would like to support for this integration. If the locales are already defined in the codebase, you can check off “Use locales currently in use in the codebase” Otherwise, this is your opportunity to define the set of languages. This can be updated later.

Next Steps

You will be prompted that the link is complete, and brought to the integration dashboard Quetzal will take some time to review your code and plan for next steps. Here you can monitor progress and configure the behavior of your integration. For a complete guide to using this dashboard, read our Integration Dashboard spec.