Skip to main content
Version: 1.1.x

Getting started

This guide covers how to include translation capabilities in your Brightspot build.

Dependencies​

Include the following dependencies in your build configuration based on your needs:

Core translation (required)​

The core translation dependency is required for all translation functionality:

<!-- Requires Brightspot 5.0 or later. -->
<dependency>
<groupId>com.brightspot.translation</groupId>
<artifactId>translation</artifactId>
<version>2.0.0</version>
</dependency>

Translation services (optional)​

Include dependencies for the specific translation services you want to use:

ArtifactDescription
com.brightspot.translation:awsAmazon Translate integration
com.brightspot.translation:deeplDeepL integration
com.brightspot.translation:googleGoogle Translate integration
com.brightspot.translation:lingotekLingotek integration

For example, to include Amazon Translate:

<!-- Requires Brightspot 5.0 or later. -->
<dependency>
<groupId>com.brightspot.translation</groupId>
<artifactId>aws</artifactId>
<version>2.0.0</version>
</dependency>

Legacy dependencies​

Older versions of Brightspot use different dependency coordinates. If you're on an older version, use these dependencies instead:

ArtifactDescription
com.psddev:translationCore translation functionality
com.psddev:translation-awsAmazon Translate integration
com.psddev:translation-googleGoogle Translate integration
com.psddev:translation-lingotekLingotek integration

For example, the core dependency:

<dependency>
<groupId>com.psddev</groupId>
<artifactId>translation</artifactId>
<version>4.8.11</version>
</dependency>

Replace the version with your project's Brightspot version.

What's included​

Once you've added the dependencies, the following capabilities are available:

  • Translation menu option in content edit pages for sending content to translation
  • Translations tab on content for viewing translation history and status
  • Site settings for configuring available locales and translation services
  • Manual translation option for human-driven translation workflows
  • Translation service integrations (if you included AWS, Google, or Lingotek dependencies)

Next steps​

  1. Configure translation settings for your site
  2. Set up your chosen translation service integration (Amazon Translate, Google Translate, or Lingotek)
  3. Learn how to send content for translation