developer-guide-i18n.md

title
Developing for Internationalization

{{< note >}} All the files you created should use UTF-8 encoding. {{< /note >}}

There are several translations available for the Harbor portal. See the available translation files for a full list of available languages.

{{< note >}} Harbor only officially supports the English and Chinese translations, and both languages are verified for each release. If you plan to use another translation, its recommended that you verify the translations are correct for your Harbor version before implementing. {{< /note >}}

Use the steps below to add a translation for a new language to the Harbor portal.

1. In the folder src/portal/src/i18n/lang, copy json file en-us-lang.json to a new file and rename it to <language>-<locale>-lang.json .

   The file contains a JSON object including all the key-value pairs of UI strings:

   {
     "APP_TITLE": {
       "VMW_HARBOR": "Harbor",
       "HARBOR": "Harbor",
       // ...
     },
     // ...
   }

   In the file <language>-<locale>-lang.json, translate all the values into your language. Do not change any keys.

2. Add the language to the set of supported languages in src/portal/src/app/shared/entities/shared.const.ts:

   export const LANGUAGES = {
       "en-us": "English",
       "zh-cn": "中文简体",
       "<language>-<locale>": "<DISPLAY_NAME>",
   } as const;

3. Next, refer to Build Harbor from Source Code to rebuild and restart Harbor.

Contributing localizations to Harbor

If you'd like to contribute your localization file to the Harbor project, please make a pull request with the changes from the instructions above. Please do your best to make sure your translations are correct and easily understood by speakers of that language.

Finding reviewers for a translation PR is best effort, maintainers may not be able to review the pull request because they do not speak or read the language of your contribution. If you know of another community member who can help with reviewing the pull request, make sure to tag them when you open the PR. You should also plan to attend a community meeting to raise awareness for your pull request and ask the community for help reviewing.

Your contribution may still be accepted without additional reviews even if we aren't able to find someone to review the translations in your pull request.