Skip to content

feat: add PREPEND_LOCALE_PATHS configuration setting - #29851

Merged
rgraber merged 1 commit into
openedx:masterfrom
open-craft:keith/se_5299_prepend_local_paths
Feb 9, 2022
Merged

feat: add PREPEND_LOCALE_PATHS configuration setting#29851
rgraber merged 1 commit into
openedx:masterfrom
open-craft:keith/se_5299_prepend_local_paths

Conversation

@keithgg

@keithgg keithgg commented Feb 1, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

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

Testing instructions

On the docker devstack:

  • make dev.shell.lms
  • Edit the file /edx/etc/lms.yml. Add a PREPEND_LOCALE_PATHS setting like
PREPEND_LOCALE_PATHS: [/edx/src/]
  • Copy a translation file into that folder.
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).

Deadline

"None"

Other information

Settings

configuration_version: keith/se_5299_prepend_local_paths
configuration_source_repo_url: https://github.com/open-craft/configuration
edx_platform_repository_url: https://github.com/open-craft/edx-platform.git

@openedx-webhooks

openedx-webhooks commented Feb 1, 2022

Copy link
Copy Markdown

Thanks for the pull request, @keithgg! I've created OSPR-6427 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:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

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.

@openedx-webhooks openedx-webhooks added needs triage open-source-contribution PR author is not from Axim or 2U labels Feb 1, 2022
@keithgg
keithgg force-pushed the keith/se_5299_prepend_local_paths branch 2 times, most recently from 7154ab5 to 773fa1a Compare February 2, 2022 07:07
@keithgg
feat: add PREPEND_LOCALE_PATHS configuration setting
77ab470 
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.
@keithgg
keithgg force-pushed the keith/se_5299_prepend_local_paths branch from 773fa1a to 77ab470 Compare February 2, 2022 07:09
@natabene

natabene commented Feb 4, 2022

Copy link
Copy Markdown
Contributor

@keithgg Thank you for your contribution. I will line this up for my review.

rgraber
rgraber approved these changes Feb 9, 2022
View reviewed changes

@rgraber rgraber left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@rgraber
rgraber merged commit 9d3f52e into openedx:master Feb 9, 2022
@openedx-webhooks

openedx-webhooks commented Feb 9, 2022

Copy link
Copy Markdown

@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.

@edx-pipeline-bot

edx-pipeline-bot commented Feb 9, 2022

Copy link
Copy Markdown
Contributor

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

@edx-pipeline-bot

edx-pipeline-bot commented Feb 9, 2022

Copy link
Copy Markdown
Contributor

EdX Release Notice: This PR may have caused e2e tests to fail on Stage. If you're a member of the edX org, please visit #e2e-troubleshooting on Slack to help diagnose the cause of these failures. Otherwise, it is the reviewer's responsibility. E2E tests have failed. https://gocd.tools.edx.org/go/tab/pipeline/history/deploy_to_stage

@edx-pipeline-bot

edx-pipeline-bot commented Feb 9, 2022

Copy link
Copy Markdown
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

keithgg added a commit to open-craft/openedx-platform that referenced this pull request Feb 14, 2022
@keithgg
feat: add PREPEND_LOCALE_PATHS configuration setting (openedx#29851)
5c999dc 
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.

https://tasks.opencraft.com/browse/SE-5299
@keithgg keithgg mentioned this pull request Feb 14, 2022
Merged
keithgg added a commit to open-craft/openedx-platform that referenced this pull request Feb 18, 2022
@keithgg
Merge pull request #460 from open-craft/keith/se_5299_lilac
6c85162 
feat: add PREPEND_LOCALE_PATHS configuration setting (openedx#29851)
@0x29a 0x29a mentioned this pull request May 4, 2022
Merged
@keithgg keithgg mentioned this pull request May 17, 2022
Merged
@Agrendalath
Agrendalath deleted the keith/se_5299_prepend_local_paths branch May 21, 2022 11:01
Agrendalath pushed a commit to open-craft/openedx-platform that referenced this pull request Jun 7, 2022
@keithgg @Agrendalath
feat: add PREPEND_LOCALE_PATHS configuration setting (openedx#29851)
23c75b3 
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.

https://tasks.opencraft.com/browse/SE-5299
Agrendalath pushed a commit to open-craft/openedx-platform that referenced this pull request Jun 7, 2022
@keithgg @Agrendalath
feat: add PREPEND_LOCALE_PATHS configuration setting (openedx#29851)
794ccc8 
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.

https://tasks.opencraft.com/browse/SE-5299
github-actions Bot added a commit that referenced this pull request Jul 3, 2022
@github-actions
merge(#30422): feat: add PREPEND_LOCALE_PATHS configuration setting t…
b006046 
…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).
@0x29a 0x29a mentioned this pull request Sep 21, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@rgraber rgraber rgraber approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

merged open-source-contribution PR author is not from Axim or 2U

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@keithgg @openedx-webhooks @natabene @edx-pipeline-bot @rgraber