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 blogpost about changing translation downloads #2136

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

joostlek
Copy link
Member

@joostlek joostlek commented Apr 5, 2024

Proposed change

Add blogpost about changing translation downloads

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Removed stale or deprecated documentation

Additional information

blog/2024-04-05-translation-key-filtering.md Outdated Show resolved Hide resolved
With this change, we only download the strings that are verified.

A verified string is a translated string, and it becomes unverified when the original string changes.
So whenever someone changes something in the original string, the translated string becomes unverified and needs to be reviewed again.
Copy link

@oyvindwe oyvindwe Apr 5, 2024

Choose a reason for hiding this comment

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

"something" is a pleonasm. "reviewed" is another Lokalize concept. Suggestions:

Suggested change
So whenever someone changes something in the original string, the translated string becomes unverified and needs to be reviewed again.
So whenever someone changes the default value of a string (i.e. changes a `strings.json` file), all translations of that key becomes unverified and must be edited or marked as verified in Lokalise.

Copy link
Contributor

Choose a reason for hiding this comment

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

So whenever the English string is modified (i.e. changes a strings.json file), all translations which refers to the same translation key becomes unverified and must be edited or marked as verified in Lokalise.


A verified string is a translated string, and it becomes unverified when the original string changes.
So whenever someone changes something in the original string, the translated string becomes unverified and needs to be reviewed again.
This is very beneficial for the translation keys that make use of translation key placeholders, since they can now never have a mismatch between the original and translated string.
Copy link

@oyvindwe oyvindwe Apr 5, 2024

Choose a reason for hiding this comment

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

I think this is better:

Suggested change
This is very beneficial for the translation keys that make use of translation key placeholders, since they can now never have a mismatch between the original and translated string.
This catches both significant changes to strings that may be hidden if the translation is not updated, and also avoids placeholder mismatches. Note that correcting typos in the default strings also will make translations "unverified".

Copy link
Contributor

Choose a reason for hiding this comment

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

This catches changes to English strings that may be hidden if the translation is not updated, and also avoids placeholder mismatches. Note that correcting typos in the English strings also will make translations "unverified".

@@ -10,7 +10,7 @@ In Home Assistant Core 2024.4.2, we are changing the way translation keys are do
Previously the script would download every translated string.
With this change, we only download the strings that are verified.

A verified string is a translated string, and it becomes unverified when the original string changes.
All translations are verified when saved, but a translation becomes unverified if the source string is changed
Copy link

Choose a reason for hiding this comment

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

Nit: missing punctuation at end of sentence.

title: "Changing the way translation keys are handled"
---

In Home Assistant Core 2024.4.2, we are changing the way translation keys are downloaded.
Copy link
Contributor

Choose a reason for hiding this comment

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

I found "downloaded" in this context is confusing. From where to where?

In Home Assistant Core 2024.4.2, we are changing the way translation are included into builds from Lokalise.


In Home Assistant Core 2024.4.2, we are changing the way translation keys are downloaded.

Previously the script would download every translated string.
Copy link
Contributor

Choose a reason for hiding this comment

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

Previously the build translation script would download every translated string.

In Home Assistant Core 2024.4.2, we are changing the way translation keys are downloaded.

Previously the script would download every translated string.
With this change, we only download the strings that are verified.
Copy link
Contributor

Choose a reason for hiding this comment

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

With this change, we only download the translations that are verified in Lokalise.

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.

None yet

3 participants