developers

No menu items for this category
OpenMetadata Documentation

How to Add Language Support

OpenMetadata offers multi-language support to provide a more accessible and localized experience for global teams. Users can change the application language from the top-right corner of the UI by selecting from a list of supported languages.

The following languages are available out of the box:

  • English (EN)
  • Korean (KO)
  • French (FR)
  • Simplified Chinese (ZH-CN)
  • Traditional Chinese (ZH-TW)
  • Japanese (JA)
  • Portuguese (Brazil) – PT-BR
  • Portuguese (Portugal) – PT-PT
  • Spanish (ES)
  • Galician (GL)
  • Russian (RU)
  • German (DE)
  • Hebrew (HE)
  • Dutch (NL)
  • Persian (PR)
  • Thai (TH)
  • Marathi (MR)
  • Turkish (TR)
Language Dropdown in UI

Language Dropdown in UI

If you'd like to:

  • Contribute a new language,
  • Customize existing translations,
  • Or enable internal company-specific terms,

You can do so by editing or adding JSON files in the locale/languages directory of the OpenMetadata frontend codebase.

Each language is structured like this:

To add support for a new language in our internationalization setup using react-i18next and i18next, please follow the steps below:

First, create a new JSON file for the language you want to add in the openmetadata-ui/src/main/resources/ui/src/locale/languages directory.

For example, if you want to add support for the French language, you can create a file called fr-fr.json in the languages directory:

To ensure consistency with our primary language, which is en-us, it is necessary to synchronize any newly added language files. This can be done by copying the content from the en-us.json file and translating it accordingly.

To copy the contents of en-us.json and add it to your translation JSON file, follow these steps:

  • Go to en-us.json
  • Copy the content of file
  • Open your translation JSON file.
  • Paste the copied text into your translation JSON file.

You can refer to the image below for a visual guide:

copy-en-us

Documentation for entities resides in the openmetadata-ui/src/main/resources/ui/src/public/locales directory. Our primary language is en-US, so you can refer to it and create the same hierarchy for your language.

To add documentation in the zh-CN language, you can simply copy the en-US directory and rename it to zh-CN. Then, update the content of the files according to the zh-CN language.

To find the supported language codes, you can refer to this page.