Consider using a localization platform #9270

I'd also like to +1 for Weblate, it seems to match our open-source philosophy.

Very nice!

The coding TODOs are now done. Keycloak is now also approved for the libre projects hosting.

Tasks that are still ongoing:

• Cleanup of existing translation files: Sometime keys have been renamed in the source files, but not in the translation files.
• Weblate doesn't support the _zero suffix used by i18next translations. This is a known issue, and it is not clear when / how this will be supported, and what a good workaround can could be for this: Weblate removes _zero postfixed keys from translation files that were touched WeblateOrg/weblate#9358

I think we can work around the _zero problem by simply not using those kinds of features. We'll just have to work around these issues until they are fixed. Let me know if I can assist with anything.

I think once we have the system in place we should formalize some kind of process for community translations. I'd like to have designated maintainers for each language that is supported. And we should likely also add a call to action on the site, blog and contributing documentation.

Update on this, we no longer need to worry about the _zero suffix, as the Admin and Account consoles have now been ported over to property files.

Thank you for this update. I've updated Weblate with the new files, and also restricted the languages to NL and DE - the languages between the two of use we are familiar with.

I've created one more PR for a cleanup before I switch Weblate to Keycloak's main repository:

• Cleanup translations for DE/EN for a first test run of Weblate #25450

Once we're happy with the process, we can then add more languages.

PRs have been merged.

Ah got it, sorry wasn't aware of this conversation. I have no objections against this approach, I'll re-open the PR.

@ahus1 Shouldnt it be better if I would first translate files on weblate, which would push files to github and to enable them in *.properties files only after?

I suppose we're are talking about the same thing still things get lost when writing them down. As there are multiple *.properties files, let's try to be more specific:

Let me try again:

• Weblate needs an empty file messages_ka.properties to start with / show the language in the Weblate UI. So adding those empty files is the first PR to the main repository.
• Once you translate in Weblate, it will create one or more PRs with your translations to the main Keycloak repository, and the files will grow.
• Once the translation is complete, there will be another PR to the main repository for the themes.properties files, so that Keycloak will actually serve those translations in the UI. You can (and probably should) have done this change locally before to verify the translations

Are we in agreement?

Got it. Any way to remove/revert last commit (adding ",ka" in theme.properties fle), please?

If you are using the web frontend of GitHub, this might be tricky. I'm helping out here and pushed some changes to the PR. Let's continue the discussion over there.

Weblate is not ready as of yet, if you wish to contribute you can open up a PR instead.

@moritz89 - The Weblate process is now live for the German translation. See https://github.com/keycloak/keycloak/blob/main/docs/translation.md to get started! @robson90 volunteered to take the lead for the German language, so please contact him with any questions you might have.

Happy to see you volunteering! AFAIK you've been contributing to the Arabic translation in the past. Is there a second native speaker you can team up to review your translations?

When I add Arabic to Weblate, the first thing Weblate will do is to removing all message keys from the messages_ar.properties files it assumes to be outdated as the don't exist in the message_en.properties. Once this happens, the first task is to review those removals and check if there was just a change in the key in message_en.properties and the translation can be saved by re-adding it to Weblate with the new key.

Happy to see you volunteering! AFAIK you've been contributing to the Arabic translation in the past. Is there a second native speaker you can team up to review your translations?

cc @Mouhand-Kaddo @alfayez91 if someone interested.

@Eng-Fouad - if you don't find volunteer here, maybe reach out to the Keycloak mailing list and see if someone wants to join.

@GioviQ - in Keycloak's translations - either by file or by Weblate, in all cases where you want to show a single ' in the UI, you will need to put a double '' in the translation. This is due to the Java Messageformat, where single quotes have a special meaning.

See "Within a String, a pair of single quotes can be used to quote any arbitrary characters except single quotes. ... " in the docs for the MessageFormat. I suppose we should add that to the translation guide: https://docs.oracle.com/javase/8/docs/api/java/text/MessageFormat.html

You mean in general or for a specific key?

Weblate will accept both. I did it always similar to the English language.

I have seen already translated strigs with single or double ' , so I was not sure whether both were correct.

If there is a single quote without a matching single quote later, the Message format will show the quote. Once there is a matching quote, then none of the quotes will be shown. It is not very intuitive. I'll see that I add an automatic check to Keycloak. Unfortunately this will only catch those situations after the translation has already been done in Weblate. I'm now going through the Italian translations.

The original idea was to escape placeholders, so '{0}' would print {0} and not replace the placeholder. Well, it turned out to be not a good idea to use a single quote for escaping...

Consider https://graphicdesign.stackexchange.com/questions/66809/what-s-the-right-character-for-an-apostrophe too

@GioviQ - yes, that's a good idea. That should work in the UIs, and I assume in emails as well.

I've created an issue to update the translation file, and also to add a validation in the build. #37931

What you can do today: You can create a pull request to update the messages_it.properties, and then find another Italian native speaker to approve that PR.

What we can do when two Italian native speakers commit to be maintainers of the Italian language: We can setup up Weblate.

I made a PR just to test the process and now I see this PR was not so easy, just like other PRs. But I learnt the "sign off" is just some sort of disclaimer in a commit and if I manually add a line in message like Signed-off-by: GioviQ <my@email> it is the same as using -s option. I discovered now every theme has its own message_{locale}.properties, so one should made the same update to all and that is not efficient. Also managing the project with Visual Studio has some issue and still I don't find a free tool to manage all the message_{locale}.properties at the same time.

The two previous language maintainers weren't able to review the translations, so we were in the process of removing it. The translation.md file is now updated.

We're looking for two new languages maintainers that are active on GitHub and Weblate. In the meantime, we'll be accepting pull requests to those translation files in the Keycloak repository directly.

We're looking for new French language maintainers who would be willing to use Weblate to keep the translation up to date.
Looking at previous PRs to the files, I see that @reda-alaoui as active, as well as @DevRebs and @jmorille.

I you or someone you know would be willing to contribute as described in translation.md, please comment here.

I am willing to contribute. But I'd need instructions and proper access.

@blackholegalaxy - that's great to hear. You can already sign up have a look at the existing translations here: https://hosted.weblate.org/projects/keycloak/#languages

About the process: Please see "Tasks of the language maintainers" for the role description in the translation.md file.

Once there is a second volunteer for the French language, we'll set up French in Weblate and expand the permissions for you and the second volunteer.

Ok will wait for a second partner then :)

@Ecron & @jmallach I added you guys to Weblate. I think we have to wait for this PR to see changes from Weblate to the upstream project.

Weblate create a cleanup PR for CA and removed two items that are no longer available in the upstream #33361.

So I'd say we are all set up, and you can check if everything looks alright in Weblate.

Will do ASAP! cc @Ecron

If an export of weblate resulted in that PR, I'd say we're all set, as there are no changes other than those two strings.

Should we be listed as admins for Catalan or something like that? I don't see anything like that in Weblate. 🤔

@jmallach & @Ecron
I dont know why, but you were removed from the Userslist. I readded you two.

I would appreciated if you extend this https://github.com/keycloak/keycloak/blob/main/docs/translation.md with language and your two names/profile links. Please see the other entries.

As far as I know you are not shown as admins for that specific language. You will be listed, when the first translations are merged.

If anything is unclear just hit me up :)

@y-tabata - I've added @tnorimat as a new Japanese language maintainer. You now should also be a team administrator so you should be able to add and remove team members.

@tnorimat - welcome to Weblate!

@ahus1 Could you add @k-tamura as the new Japanese language maintainer? @k-tamura 's Weblate username is k-tamura.
Or can I, a team administrator, add a language maintainer? I looked at the documentation, but I couldn't really understand what a team administrator can do.
https://docs.weblate.org/en/latest/admin/access.html#team-administrators

@y-tabata what are you trying to achieve ?
Should he replace you ?
Do you want a third Japanese maintainer ?

@robson90 This is to add a fourth Japanese language maintainer and speed up approval of translations.

OK, @k-tamura is now also a team member for Japanese in Weblate. @y-tabata - can you please create a PR to add him to the translation.md file? Thanks!

Sorry for the slow reply. I had a look at the administration of Weblate, and it seems that I missed to add the permission to "review strings" to the admins of each language.

I have now fixed that, again sorry for missing it earlier.

You should now have an additional radio box with "Review state" where you can change a translation to "Approved" (see screenshot below).

In the "Tools" menu, is also the option to bulk-edit translations and change their status. Use it with caution.

Hi, there is a translations docs that explains it: once there are two volunteers that review the docs regularly, we can add a language to weblate. Until then, there is the process with pull requests.

Thank you, in the Telegram there it keycloak_ru chat where you may find reviewers for the ru locale.

AFAIK that channel is in the Russian language. So if your Russian is good enough to get 2-3 volunteers involved here, please go ahead and we can add Russian in Weblate.

My username on Weblate is the same as in github: ognjen-it

Can I start working on it and maybe in mind time someone will join me?

That hasn't worked yet on the past, so I recommend against it. It would also mean that you put work into a translation that only become visible when (and only when) there is a reviewer. So I suggest to wait / actively search for a collaborator.

Thank you for volunteering! The essence of the docs is:

• When someone from the community adds a translation, one of you reviews it.
• Whenever one of you adds a translation, the other one reviews it.
• Weblate helps with that as you can set up notifications and mark new translations as "approved".
• Whenever there is a release in the 3-month release cycle, I ask you to catch up with the reviews of any new translations, so all translations for your language are marked as "approved".

To continue, I ask you to register with Weblate, and post your user names here. I then set you up with the necessary permissions.

By default, I would set up all themes (login, email, account, admin) in Weblate. If you want fewer themes to be set up, let me know.

my username petrov9

my username in Weblate is pasternake

The Russian language is now set up in Weblate, and I've invited you as team members for the Russian language. All existing translations are already marked as "Approved" assuming they have been reviewed when their pull requests have been merged to the main repository.

In the component overview, you see items that have not yet been translated, or where some checks are failing: https://hosted.weblate.org/projects/keycloak/-/ru/#components

If you think any English source string needs fixing, please create a GitHub (bug) issue in the Keycloak repository and create a pull request as before.

Thanks for volunteering, you have a friend that can help you with translating ?

Hello, I'm the original translator of Keycloak for the Greek language.
I'm willing to help and review any greek translations my username is the same as in gh.

@infl00p / @knaiskes - great! You both now got an invite to the Keycloak team on Weblate!

There is currently no translation set up for the Admin UI. If you want to start with this, let @robson90 and me know, and we'll add it.

@robson90 - can you please update the translation.md file as usual?

Thank you for your patience, you're now set up in Weblate with the necessary permissions. At the moment there is no translation added for the Admin UI. If you eventually want to start one, please let me know.

All translations in Weblate for traditional Chinese are now marked as "approved". You can set up notifications in Weblate when there are new untranslated strings, or any suggestions from the community with updated items.

@robson90 - can you please add traditional Chinese and also Russian to the translation.md file when you have the time? Thanks!

Thank you, @ahus1.

Everything is working well in Weblate!
Could you help enable the Admin UI translation so we can start working on Traditional Chinese?
We're happy to contribute translations for the Admin UI as well.

@ahus1 I just checked the config on Weblate for the Admin UI, it seems to be correct.

But for whatever reason, the zh_hant.properties is missing here: https://github.com/keycloak/keycloak/tree/main/js/apps/admin-ui/maven-resources-community/theme/keycloak.v2/admin/messages

Should I add it in conjunction with the changes to the translations.md ?

@robson90 - we're currently struggling with some unstable UI tests. While I normally would say it is ok to add it in the same PR, please create a separate one this time.

@allen0099 & @benwater12 fyi, you should be able to translate the admin UI component now. I added the properties file.

If you encounter hick ups, please do not hesitate to message me.

My Weblate username is @syahmin

Thank you for sharing your Weblate usernames.

Indonesian is now all set up on Keycloak's Weblate project: https://hosted.weblate.org/projects/keycloak/-/id/#components

@atriwidada, @princeofgiri, @syahmins are now set up in Weblate. I'll add @raniaamina to the team one you confirmed your Weblate username.

I suggest you start with one of the components (for example the login theme). Once your translation is on a good way, let me know and I'll add it to the nightly builds of Keycloak. BTW, the next official release of Keycloak is scheduled for end of March. If you want, we can ship your Indonesian translation in that release.

Sorry for late response, my weblate username is raniaamina

@raniaamina - welcome to the team, you're now also set up on Weblate!

Thank you!

Here's my weblate profile: https://hosted.weblate.org/user/jasonqsong/

Hello @jasonqsong - thank you for reaching out and volunteering.

A translation is active as long as the community keeps it active. As my knowledge of how to best translate Han script, I leave it to the community to decide to proceed. As with all translations, we need two people to agree and review each others changes.

We can proceed with the translation in the PR listed above as long as you and a second native speaker agree on it and are willing to maintain it.

Is is then up to you if want to

• Periodically run the Python script, review the output and submit a pull request
• After this first PR switch to a manual translation via Weblate

In theory you could add openCC to our build process, still it seems to me that there hasn't been a release for over one year, so we'd consider it possibly not well supported, so we would rather not make it part of our build.

Whatever way you choose for Han script, we should record the decision and the process in the translation.md file.

Thank you very much for clarifying! My colleague's weblate profile is https://hosted.weblate.org/user/charliedcc/

For minimizing the gap, we'd prefer to transcode the Hant script first, then manually reword some parts to make the tone more native. I'll create a PR to document the strategy after zh_Hans is on the weblate.

@jasonqsong / @charliedcc - welcome to the team! You're now all set up and have the extended permissions in Weblate.

All translations in Weblate are already marked as "approved", as they have been reviewed earlier when those pull requests were merged. Any new translations that you do, please eventually peer-review them and mark them as approved.

You also have the permissions to upload and download files if this suits your workflow better once you choose a specific component and a specific language - for example on page https://hosted.weblate.org/projects/keycloak/account-ui/zh_Hans/

If there is anything people should know before contributing to Simplified Han script, please add it to the translation.md file via a pull request.

@robson90 - please update the translation.md with the new language maintainers. Thanks!

@mathmul - thank you for your feedback and enthusiasm! Whenever we change an English text or add new keys, your "percentage" will go down. Either check in every other month, or set up Weblate to send you notifications about changed and new keys 😄

Thanks, I've commented on the PR.

Thank you very much for your contribution! The PR is now merged.

All translations are now visible in Weblate: https://hosted.weblate.org/projects/keycloak/-/vi/#components

As @thangnm11 created the PR, and AFAIK @it-site44-com hasn't reviewed the initial translation, all translated are marked for review in Weblate. @it-site44-com can either review them one by one, or as a bulk edit via the UI https://hosted.weblate.org/projects/keycloak/-/vi/#bulk-edit

In case you you find anything that needs changing in the original English string, please create a bug issue in the Keycloak repository and create a pull request. We currently allow direct edits via Weblate as those changes would usually require more discussion that is better handled on GitHub.

Happy translating and let me know if you have any questions!

Hello @ahus1,
When will our Vietnamese - Vietnam (vi-vn) language be officially released?