Skip to content

Conversation

@DitteKKoustrup
Copy link
Contributor

Reason for creation

I looked into whether Umbraco already has some documentation on how users can contribute to translating Umbraco Backoffice, to make sure the translations remain clear, consistent, and user-friendly for everyone.

I could not find this, therefore I created one.

Description

  • Created a Markdown file to be part of the Contribution Documentation on Github
  • Made a Step-by-step guide on how to find, add, edit and change localization in the code and Backoffice.
  • Added helpful images to the text.

Copy link
Contributor

@AndyButland AndyButland left a comment

Choose a reason for hiding this comment

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

This is great @DitteKKoustrup - thanks for taking the time to prepare this.

All I would suggest would be looking to link it up with existing documentation. So for example, this page has a section titled "Further contribution guides" - it would be good to link your article in there.

And perhaps vice versa, when you talk about forks and PRs, it might be better to link to back to the content here.

@andersreus
Copy link
Contributor

Awesome PR @DitteKKoustrup 🎉

In the example I looked up, the key found in the element was not identical to the one found in the translation file.

In the element it was "user_emailDescription", so it was prefixed with "user_" which indicated that the "emailDescription" was located under the "user" section. So there is a group localization and a key localization if that makes sense 😅

When you search the translation file you will use the key localization part, which in my case was "emailDescription".
This is a minor detail but could be an issue for some contributors that search the entire key given from the element and then can't find it because of that.

Maybe it could be an idea to have a link to the Umbraco CMS docs around language files and localization.
So while contributing to the Umbraco backoffice translation, you could read on un how these languages files works if any questions popped up.

Could be this page, or maybe you have something better you can find 👍

@Migaroez
Copy link
Contributor

Migaroez commented Mar 4, 2025

This Docs article is probably a better fit
https://docs.umbraco.com/umbraco-cms/customizing/foundation/localization

@nielslyngsoe
Copy link
Member

I'm not sure this should go in the Documentation. Documentation is for those who want to build with the software or want to extend the software. This is specifically for someone contributing to making changes to our localizations, so I think its a good fit in our Source Code.

@iOvergaard iOvergaard changed the base branch from v15/dev to main May 5, 2025 13:13
@iOvergaard iOvergaard added the category/dx Developer experience label May 5, 2025
@iOvergaard iOvergaard merged commit 489322a into main May 5, 2025
22 checks passed
@iOvergaard iOvergaard deleted the ditte/localizationContributionDocumentation branch May 5, 2025 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

category/dx Developer experience

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants