Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add translation.md for Weblate.org #29447

Merged
merged 7 commits into from May 15, 2024
Merged

Conversation

robson90
Copy link
Contributor

@robson90 robson90 commented May 10, 2024

Closes #29548

@jonkoops
Copy link
Contributor

Thanks for the PR. Could you link an issue to the PR so that we can track this one? Please also make sure to link any previous discussion in said issue.

@jonkoops jonkoops requested review from jonkoops and ahus1 May 13, 2024 14:20
@ahus1 ahus1 self-assigned this May 13, 2024
docs/translation.md Show resolved Hide resolved
Thank you for your interest in contributing translations to Keycloak! Translations play a crucial role in making Keycloak accessible to users from diverse linguistic backgrounds. This document provides guidelines for contributing translations and getting started with Weblate.

## Why Translation Matters
Translation enables Keycloak to reach a wider audience by making the platform usable for speakers of various languages. By translating Keycloak, you help improve accessibility and usability for users who may not be proficient in English.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if we need this paragraph, as it's kinda already covered by the previous one:

Translations play a crucial role in making Keycloak accessible to users from diverse linguistic background.

Perhaps roll these up into one paragraph?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a fan of a heading that explains the "why", so I tend to keep it. I removed one sentence from the first paragraph. Let me know what you think.

docs/translation.md Outdated Show resolved Hide resolved
docs/translation.md Outdated Show resolved Hide resolved
docs/translation.md Outdated Show resolved Hide resolved
docs/translation.md Outdated Show resolved Hide resolved
docs/translation.md Outdated Show resolved Hide resolved
docs/translation.md Outdated Show resolved Hide resolved
docs/translation.md Outdated Show resolved Hide resolved
ahus1 and others added 5 commits May 14, 2024 17:15
Co-authored-by: Jon Koops <jonkoops@gmail.com>
Co-authored-by: Jon Koops <jonkoops@gmail.com>
Co-authored-by: Jon Koops <jonkoops@gmail.com>
Co-authored-by: Jon Koops <jonkoops@gmail.com>
Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
@ahus1
Copy link
Contributor

ahus1 commented May 14, 2024

@robson90 - I pushed some changes. The major change is that I updated "language" with "translation", and then removed English from the list, as that is not a translation, but the source.

IMHO only those translations are in scope for this document, and not the source language.

docs/translation.md Outdated Show resolved Hide resolved
@robson90
Copy link
Contributor Author

@robson90 - I pushed some changes. The major change is that I updated "language" with "translation", and then removed English from the list, as that is not a translation, but the source.

IMHO only those translations are in scope for this document, and not the source language.

@ahus1 Im fine with he changes, thanks for taking this over! 🎉

Could you please check if it is possible to disable the language request on Weblate ? Then we have only one point of interaction.

Co-authored-by: Robin Meese <39960884+robson90@users.noreply.github.com>
@ahus1
Copy link
Contributor

ahus1 commented May 15, 2024

Could you please check if it is possible to disable the language request on Weblate ? Then we have only one point of interaction.

I found that I can switch in each component, in the settings on the tab "Files", I can choose for "Add new translation" the option "Point to translation instructions URL".

Once this PR is then merged, we can update the "Translation instructions" in the settings for the Weblate Keycloak project to this new translation.md file.

@ahus1 ahus1 marked this pull request as ready for review May 15, 2024 06:31
@ahus1 ahus1 requested a review from a team as a code owner May 15, 2024 06:31
@ahus1 ahus1 requested a review from jonkoops May 15, 2024 06:31
@ahus1
Copy link
Contributor

ahus1 commented May 15, 2024

@jonkoops - could you please re-review the latest changes if you are ok to merge this PR as a first version? Once it is merged, I'll update the translation instructions to point to the new file. Once that is in place, IMHO we are ready to add one more language.

Copy link
Contributor

@jonkoops jonkoops left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just a couple of comments, but feel free to merge.


Keycloak welcomes translations of its user interfaces and error messages via Weblate.

There is also a [Keycloak Documentation translation project](https://github.com/openstandia/keycloak-documentation-i18n).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps good to mention that this is not maintained by the Keycloak team itself, but a third party.


Please note that while we aspire to support more translations in the future, our current focus is on these translations. We rely on volunteers like you to take the initiative in steering the translation efforts for additional translations. If you're interested in contributing translations for a language not listed above, add a comment to the [localization platform discussion](https://github.com/keycloak/keycloak/discussions/9270).

If you have any questions or need assistance, feel free to reach out to the language maintainers listed below:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could also create a nomination proccess here, if someone wants to volunteer to be a maintainer for the translations of a specific language on Weblate, we can ask them to open a PR to add a new language here and add their name as a maintainer. WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like a follow-up PR to me. For the time being, the "If you're interested in contributing translations for a language not listed above, add a comment" should work.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should link this document from the contribution guide as well, so that folks end up here when they are looking to contribute.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes - this is the next step as discussed with @robson90

@ahus1 ahus1 merged commit 87086dd into keycloak:main May 15, 2024
48 of 49 checks passed
@ahus1
Copy link
Contributor

ahus1 commented May 15, 2024

Thank you for everyone who contributed. This is now linked in the project description on Weblate: https://hosted.weblate.org/projects/keycloak/#information

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide instructions on how to use Weblate for translations
3 participants