Submodule i18n

[catreedle]

Contributor checklist

• This pull request is on a separate branch and not the main branch
• I have tested my code with the ./gradlew lintKotlin detekt test command as directed in the testing section of the contributing guide

---

Description

• Replace i18n directory with the scribe-org/Scribe-i18n Git submodule
• Updated CONTRIBUTING.md to document cloning and working with the i18n submodule
• Updated android_ci.yml to ensure Git submodules are checked out in CI
• Updated update_i18n_keys.sh to pull and commit the latest changes from the i18n submodule

Related issue

• Closes Switch Scribe-i18n from git subtree to git submodule #527
• Closes App language resets to English when Indonesian is selected #515

[github-actions]

Thank you for the pull request! 💙

The Scribe-Android team will do our best to address your contribution as soon as we can. If you're not already a member of our public Matrix community, please consider joining! We'd suggest that you use the Element client as well as Element X for a mobile app, and definitely join the General and Android rooms once you're in. Also consider attending our bi-weekly Saturday dev syncs. It'd be great to meet you 😊

Note

Scribe uses Conventional Comments in reviews to make sure that communication is as clear as possible.

[github-actions]

Maintainer Checklist

The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

• Tests for changes have been written and the unit test, linting and formatting workflows within the PR checks do not indicate new errors in the files changed

  • Tests may need to be reran as they're at times not deterministic

• The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

[andrewtavis]

@angrezichatterbox and @DeleMike: The commits that are in this PR now have us in a really great place as far as switching Scribe-i18n over to a submodule rather than a subtree. @catreedle will work on fixing the hard coded strings and keys that have changed since the last update of Scribe-i18n within the project, and then it'd be great if we could do a through review seeing as how this will update many of the texts across the application 😊

Great work so far, @catreedle!

[andrewtavis]

note: Updated the PR description to reflect that this PR will close #527 and #515. We need to bring in the latest version of Scribe-i18n, and then this will finalize both once we fix any keys that are now different and replace some hard coded strings with keys. Let us know if you need support here, @catreedle!

note: Closed #526 in favor of this PR :)

[DeleMike]

Hi @andrewtavis , I missed the session yesterday to learn how to use the scribe-org/Scribe-i18n Git submodulein the Android app. Can you point me to a resource to see how to see this new update in action in the Android app?

[andrewtavis]

Hi @DeleMike 👋 You can check the docs for Scribe-i18n - the readme - that explains it all. @catreedle will load in the submodule and then we'll be able to edit and load in new versions 😊

[DeleMike]

Hi @DeleMike 👋 You can check the docs for Scribe-i18n - the readme - that explains it all. @catreedle will load in the submodule and then we'll be able to edit and load in new versions 😊

Thank you @andrewtavis , I will go through it. Thank you!

[andrewtavis]

Let us know when this is ready, @catreedle :) And feel free to start on bringing Scribe-i18n into Scribe-iOS when you're done here :)

[catreedle]

Let us know when this is ready, @catreedle :) And feel free to start on bringing Scribe-i18n into Scribe-iOS when you're done here :)

Hi @andrewtavis

question: what to do when some strings are missing for Android but they are already available in i18n, for example "i18n._global.privacy_policy": "Privacy Policy". Because they don't start with "i18n.app" they got filtered out by the convert_jsons_to_strings script?

[andrewtavis]

Great question, @catreedle :) We should update the script to also convert the i18n._global* keys as well. Do you want to do that in Scribe-i18n? And can you look into the iOS conversion to make sure that the xcstrings file is also only getting the i18n.app and i18n._global keys? Maybe it already is, but we should check :)

[andrewtavis]

I'll quickly merge in the changes to Scribe-i18n and then you can bring them over to this PR :)

[catreedle]

Great question, @catreedle :) We should update the script to also convert the i18n._global* keys as well. Do you want to do that in Scribe-i18n? And can you look into the iOS conversion to make sure that the xcstrings file is also only getting the i18n.app and i18n._global keys? Maybe it already is, but we should check :)

sure!

[catreedle]

I'll quickly merge in the changes to Scribe-i18n and then you can bring them over to this PR :)

made the PR here :)
scribe-org/Scribe-i18n#101

[andrewtavis]

Scribe-i18n has been updated, @catreedle :) Note that I needed to do another commit after I merged your PR as the scripts needed to factor for i18n._global, not i18n.global (we do _global so it's alphabetically before). Let us know when this is ready to be finalized!

[catreedle]

Scribe-i18n has been updated, @catreedle :) Note that I needed to do another commit after I merged your PR as the scripts needed to factor for i18n._global, not i18n.global (we do _global so it's alphabetically before). Let us know when this is ready to be finalized!

thank you! :) sorry for the oversight

[andrewtavis]

No need to apologize, @catreedle! 💙🩵

[andrewtavis]

Checking in, @catreedle, are we ready for a review here?

[catreedle]

Checking in, @catreedle, are we ready for a review here?

yes @andrewtavis, ready for review 😊

[DeleMike]

Hi @catreedle , currently looking at your work.

Well done!

[DeleMike]

@angrezichatterbox and @DeleMike: The commits that are in this PR now have us in a really great place as far as switching Scribe-i18n over to a submodule rather than a subtree. @catreedle will work on fixing the hard coded strings and keys that have changed since the last update of Scribe-i18n within the project, and then it'd be great if we could do a through review seeing as how this will update many of the texts across the application 😊

Thanks @andrewtavis, I have gone through it with the help of @catreedle, and the app is running as usual.

I was able to run it well and also understand the following:

• If I am opening a project for the first time, how do I use this Scribe-i18n?
  Answer: run git clone --recurse-submodules

• If it already exists on the project, how do I get the latest values to sync properly with the project?
  Answer: run git submodule update --init --recursive

---

I ran the second command, and it was able to generate some files as seen in the attached image.

---

The files generated seem pretty consistent. Only surprise here was that the uk directory was empty. @catreedle replied me via my Matrix DM that it is because the other languages have not been updated yet so there are missing keys.

One thing is the documentation will need to be really explicit in steps so that people don't get stucked while trying to setup the project localization modules or use localized strings.

Also, @andrewtavis, is there also a specific thing I need to be looking at on this PR(so I do not miss out on an important thing)? This is what I understand so far.