feat: add custom html templates for components by keithgg · Pull Request #30108 · openedx/openedx-platform

keithgg · 2022-03-23T11:24:01Z

Description

At Opencraft, we have clients that want to be able to add custom HTML templates that show up while creating course components in Studio.

Currently, there's no way to achieve this besides forking edx-platform and adding the yaml files to common/lib/xmodule/xmodule/templates/

This PR allows operators to set a custom directory where templates can be additionally loaded from.

Checks if settings.CUSTOM_RESOURCE_TEMPLATES_DIRECTORY exists.
If so, load the yaml files with the same logic as in the xmodule/templates directory.

Supporting information

Configuration PR: feat: added new setting CUSTOM_RESOURCE_TEMPLATES_DIRECTORY openedx-unsupported/configuration#6706
Custom Client Branch: [SE-5135] Update HTML templates to the v2 counterparts. open-craft/openedx-platform#453
Task: https://tasks.opencraft.com/browse/BB-5885
Sandbox: https://studio.pr30108.sandbox.opencraft.hosting [Sandbox]

Testing instructions

Update the setting settings.CUSTOM_RESOURCE_TEMPLATES_DIRECTORY to a valid path.
In that directory create an html directory.
Copy a template from common/lib/xmodule/xmodule/templates/html to the above directory with a different filename.
In the Studio, edit a Unit. Under the Text component you should see your new template list (on the Sandbox I've added many).

Deadline

"None"

Other

Settings

EDXAPP_CUSTOM_RESOURCE_TEMPLATES_DIRECTORY: /edx/var/edx-themes/edx-themes/resource-templates
edx_platform_commit: keith/bb_5583_themed_html_templates
edx_platform_repository_url: https://github.com/open-craft/edx-platform.git
configuration_source_repo_url: https://github.com/open-craft/configuration.git
configuration_version: keith/bb_5583_themed_html_templates

openedx-webhooks · 2022-03-23T11:24:09Z

Thanks for the pull request, @keithgg! 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.

natabene · 2022-03-24T20:57:18Z

@keithgg Thank you for your contribution. Please let me know once it is ready for our review.

keithgg · 2022-03-28T13:22:18Z

@natabene this is ready for review.

navinkarkera · 2022-03-28T14:56:03Z

👍

I tested this: (followed steps mentioned in test instructions)
I read through the code
I checked for accessibility issues
Includes documentation

giovannicimolin

@keithgg It's working perfectly for me. I left a few comments on the code, but mostly as suggestions to start a discussion.

Also, this needs a bit more documentation somewhere (maybe in the class description? and simple tips like file needs to be yaml, not yml, file structure needs to match the block type, etc).

keithgg · 2022-07-07T07:59:38Z

@giovannicimolin @pkulkark I've made the requested changes. Please take a look.

pkulkark

@keithgg Just the one nit about using dictionary object over list. Otherwise LGTM 👍

👍

I tested this: Verified this works as expected (on a different sandbox)
I read through the code
~~I checked for accessibility issues~~ N/A
~~Includes documentation~~ N/A

pkulkark · 2022-07-11T12:13:08Z

@giovannicimolin It looks like I can't merge this unless you add your approval too. Unless I don't have the right access to merge (I should have since I'm a core committer)? CC @natabene

giovannicimolin · 2022-07-19T14:19:05Z

@pkulkark Approved based on your review.

This setting allows loading of Resource Templates from outside the edx-platform codebase. Operators will be able to add their own custom resource templates without needing to fork the codebase.

openedx-webhooks · 2022-07-20T07:11:44Z

@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 · 2022-07-20T08:18:20Z

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

edx-pipeline-bot · 2022-07-20T08:58:29Z

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

edx-pipeline-bot · 2022-07-20T08:58:30Z

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

openedx-webhooks added open-source-contribution PR author is not from Axim or 2U waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Mar 23, 2022

keithgg force-pushed the keith/bb_5583_themed_html_templates branch from bb54ee8 to afe9048 Compare March 23, 2022 12:16

keithgg changed the title ~~feat: add custom html templates for components in theme~~ feat: add custom html templates for components Mar 25, 2022

keithgg mentioned this pull request Mar 25, 2022

feat: added new setting CUSTOM_RESOURCE_TEMPLATES_DIRECTORY openedx-unsupported/configuration#6706

Merged

keithgg marked this pull request as ready for review March 28, 2022 13:21

openedx-webhooks added needs triage waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Mar 28, 2022

natabene removed the needs triage label Mar 30, 2022

openedx-webhooks added the awaiting prioritization label Mar 30, 2022

keithgg force-pushed the keith/bb_5583_themed_html_templates branch from 9c63e21 to d62de86 Compare April 4, 2022 10:32

openedx-webhooks removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Apr 4, 2022

keithgg mentioned this pull request Apr 4, 2022

feat: added new setting CUSTOM_RESOURCE_TEMPLATES_DIRECTORY open-craft/configuration#189

Merged

keithgg force-pushed the keith/bb_5583_themed_html_templates branch from d62de86 to 59e68bd Compare April 5, 2022 10:34

openedx-webhooks added needs triage and removed awaiting prioritization labels Apr 5, 2022

keithgg force-pushed the keith/bb_5583_themed_html_templates branch from 59e68bd to dcadd21 Compare April 5, 2022 11:59

openedx deleted a comment from openedx-webhooks Apr 5, 2022

openedx-webhooks added community manager review open edx community review and removed community manager review labels Apr 6, 2022

natabene assigned giovannicimolin May 31, 2022

giovannicimolin suggested changes May 31, 2022

View reviewed changes

Comment thread cms/envs/common.py Outdated

Comment thread lms/envs/common.py Outdated

Comment thread common/lib/xmodule/xmodule/x_module.py Outdated

openedx-webhooks removed the needs triage label May 31, 2022

openedx-webhooks removed the open edx community review label Jul 6, 2022

keithgg force-pushed the keith/bb_5583_themed_html_templates branch 3 times, most recently from cbb4e60 to b54c79e Compare July 7, 2022 07:28

keithgg commented Jul 7, 2022

View reviewed changes

Comment thread xmodule/x_module.py Outdated

keithgg requested a review from giovannicimolin July 7, 2022 07:58

pkulkark reviewed Jul 11, 2022

View reviewed changes

Comment thread xmodule/x_module.py Outdated

pkulkark approved these changes Jul 11, 2022

View reviewed changes

pkulkark assigned keithgg and unassigned giovannicimolin Jul 11, 2022

pkulkark self-requested a review July 11, 2022 10:22

pkulkark approved these changes Jul 11, 2022

View reviewed changes

pkulkark requested review from pkulkark and removed request for giovannicimolin July 11, 2022 12:09

pkulkark approved these changes Jul 11, 2022

View reviewed changes

giovannicimolin approved these changes Jul 19, 2022

View reviewed changes

feat: added new setting CUSTOM_RESOURCE_TEMPLATES_DIRECTORY

ed81774

This setting allows loading of Resource Templates from outside the edx-platform codebase. Operators will be able to add their own custom resource templates without needing to fork the codebase.

keithgg force-pushed the keith/bb_5583_themed_html_templates branch from b54c79e to ed81774 Compare July 20, 2022 06:45

pkulkark merged commit 145a30a into openedx:master Jul 20, 2022

pkulkark deleted the keith/bb_5583_themed_html_templates branch July 20, 2022 07:12

keithgg mentioned this pull request Jul 21, 2022

feat: added new setting CUSTOM_RESOURCE_TEMPLATES_DIRECTORY #30759

Closed

0x29a mentioned this pull request Sep 21, 2022

[BB-6692] Prepare opencraft-release/nutmeg.2 branch for edx-platform open-craft/openedx-platform#490

Merged

keithgg mentioned this pull request Oct 6, 2022

(redo) feat: added new setting CUSTOM_RESOURCE_TEMPLATES_DIRECTORY #31117

Closed

Uh oh!

Conversation

keithgg commented Mar 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Deadline

Other

Uh oh!

openedx-webhooks commented Mar 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

natabene commented Mar 24, 2022

Uh oh!

keithgg commented Mar 28, 2022

Uh oh!

navinkarkera commented Mar 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

giovannicimolin left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

keithgg commented Jul 7, 2022

Uh oh!

Uh oh!

pkulkark left a comment

Choose a reason for hiding this comment

Uh oh!

pkulkark commented Jul 11, 2022

Uh oh!

giovannicimolin commented Jul 19, 2022

Uh oh!

openedx-webhooks commented Jul 20, 2022

Uh oh!

edx-pipeline-bot commented Jul 20, 2022

Uh oh!

edx-pipeline-bot commented Jul 20, 2022

Uh oh!

edx-pipeline-bot commented Jul 20, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

keithgg commented Mar 23, 2022 •

edited

Loading

openedx-webhooks commented Mar 23, 2022 •

edited

Loading

navinkarkera commented Mar 28, 2022 •

edited

Loading

giovannicimolin left a comment •

edited

Loading