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

ADR for basic internationalization (1343) #1427

Merged
merged 3 commits into from
Jul 12, 2024
Merged

ADR for basic internationalization (1343) #1427

merged 3 commits into from
Jul 12, 2024

Conversation

eric-gade
Copy link
Collaborator

What does this PR do? 🛠️

This PR addresses #1343 by providing an ADR for how we will initially set up internationalization for static / templated text.

What does the reviewer need to know? 🤔

This is just the ADR. A follow-on PR will be filed that includes the initial implementation for English.

### Consequences
By using our own custom, separate module for storing and enabling our own translation files, we keep all the translation information in one place. Additionally, if we need to include any custom code and/or hooks for dealing with probable translation edge cases (think right-to-left languages or special character sets), we will already have a module where we can add that custom code.

The use of translation files allows us to store the translation in ur code repository and keep it versioned. It also allows us to programmatically track changes to any translations as we proceed. Additionally, we can later develop intergrated tests to make sure we are accounting for all text that should be translated, as well as pruning translations that are no longer used.
Copy link
Member

Choose a reason for hiding this comment

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

"our code repository"

@loganmcdonald-noaa
Copy link
Member

Do we know exactly where the .po files will be stored?

Copy link
Member

@loganmcdonald-noaa loganmcdonald-noaa left a comment

Choose a reason for hiding this comment

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

Question and one typo, but overall LGTM!

@eric-gade
Copy link
Collaborator Author

Do we know exactly where the .po files will be stored?

The files will live under our custom module where we store everything related to internationalization. Provisionally something like: web/weather_i18n/translations/*.po

@eric-gade eric-gade mentioned this pull request Jul 11, 2024
@eric-gade eric-gade merged commit d27db2c into main Jul 12, 2024
13 checks passed
@eric-gade eric-gade deleted the eg-i18n-adr-1 branch July 12, 2024 17:55
This pull request was closed.
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.

2 participants