feat: add PREPEND_LOCALE_PATHS configuration setting - #6677
Conversation
edx-platform supports COMPREHENSIVE_THEME_LOCALE_PATHS setting, which appends paths to the end of LOCALE_PATHS, but there's currently no way to add additional paths to the start of the list. We want to be able to prepend locale paths so that we can override existing translations in edx-platform.
|
Thanks for the pull request, @keithgg! I've created OSPR-6426 to keep track of it in JIRA, where we prioritize reviews. Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
|
@keithgg Thank you for your contribution, I will line this up for our review. |
|
@keithgg 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
…5299_prepend_local_paths feat: add PREPEND_LOCALE_PATHS configuration setting (cherry picked from commit e397261)
…5299_prepend_local_paths feat: add PREPEND_LOCALE_PATHS configuration setting (cherry picked from commit e397261)
…5299_prepend_local_paths feat: add PREPEND_LOCALE_PATHS configuration setting (cherry picked from commit e397261)
…o Maple #Description Backports the changes made in #29851 to `maple.master`. > edx-platform currently supports COMPREHENSIVE_THEME_LOCALE_PATHS setting, which appends paths to the end of LOCALE_PATHS, but there's currently no way to add additional paths to the start of the list to override the default translations. > > In this PR, we added the PREPEND_LOCALE_PATHS setting to achieve this. > > - Affects the Operator ## Supporting information - PR for the `configuration` repo. openedx-unsupported/configuration#6677 - [SE-5299](https://tasks.opencraft.com/browse/SE-5299) ## Testing instructions On the docker devstack: - `make dev.shell.lms` - Edit the file `/edx/etc/lms.yml`. Add a `PREPEND_LOCALE_PATHS` setting like ```yaml PREPEND_LOCALE_PATHS: [/edx/src/] ``` - Copy a translation file into that folder. ```bash cp -r /edx/app/edxapp/edx-platform/conf/locale/fr/ /edx/src/es ``` Note that this is copying French to Spanish folder. It makes seeing the differences easier. - In your browser load the LMS, and change the `openedx-language-cookie`'s value to `es`. - Restart your lms dev server. - If done correctly you should get the french translations loaded (it sometimes takes 5 minutes to load).
edx-platformcurrently supports COMPREHENSIVE_THEME_LOCALE_PATHS setting, which appends paths to the end of LOCALE_PATHS, but there's currently no way to add additional paths to the start of the list to override the default translations.In this PR, we added the
PREPEND_LOCALE_PATHSconfiguration setting to achieve this.Configuration Pull Request
Make sure that the following steps are done before merging:
If you are updating a secure value rather than an internal one, file a SRE ticket with details.If you are making a complicated change, have you performed the proper testing specified on the Ops Ansible Testing Checklist? Adding a new variable does not require the full list (although testing on a sandbox is a great idea to ensure it links with your downstream code changes).Think about how this change will affect Open edX operators. Have you updated the wiki page for the next Open edX release?