Olive
Note: the Olive master branches were created on October 11th 2022. Code on master/main will now be part of Palm. Note your changes there.
If you have a fix for Olive, make a pull request against open-release/olive.master
The 15th Open edX community release will be named Olive. It will be released December 9th, 2022. The open-release/olive.master branches will be created two months earlier, on October 10th. Code on master/main as of October 10th will be part of Olive. Code merged after that will need special handling to be part of Olive.
Put stuff here that we have to remember when we start packaging up Olive. Especially important is information that system installers or operators will need to know. Please include your name when you add an item, so that we can get back to you with questions.
Operational
The Learning MFE is no longer optional, and must be run it as part of your installation now. It has been the default for a couple releases with an opt-out, but that opt-out has been removed (see Deprecations & Removals below for more).
Feature Changes
Added features
[@TJ Tracy (Deactivated) & @Kelly Buchanan ] The Learner records MFE is now available as an optional frontend for Credentials
Currently, the implementation of public records is not fully tested, and the old UI is used for public links to records on edx.org. Known Bugs:
If a public link to a learners records is generated and then used, it will route back to the old credentials UI. This was fixed in Make public record URLs redirect both ways · Issue #108 · openedx/frontend-app-learner-record , which we can patch to Olive if desired.
Masquerading is not supported in the MFE as it was in Credentials.
Instead, there’s and added records tab within the support tools to accomplish the same tasks that masquerading would normally be used for: GitHub - openedx/frontend-app-support-tools: Micro-frontend with a series of support tools for edx-platform
This MFE is not currently configured to operate inside the dockerized devstack, and is run locally for development. We have tested this MFE with Tutor and official support is pending, see LRMFE: Tutor support · Issue #97 · openedx/frontend-app-learner-record .
By default, it is not linked to in the UI, which can be changed with settings inside credentials and the profile MFE. See the MFE README for configuration information.
[DEPR]: Remove Persistent Course Grades Flags · Issue #29 · openedx/public-engineering
By default, all grades will now be persisted in the database. This will be a change from the previous default behavior, where grades were not persisted. This should be a performance improvement for installations that did not previously have this flag on.
The platform had a bad response time due to the file I/O when it's running in docker the more themes you added to your platform the slower the reponse. Now by using LRU cache when searching themes, the performance was improved.
Deprecations and Removals
Based on estimated dates 2022-04-11 to 2022-10-10.
The GitHub - openedx-unsupported/frontend-learner-portal-base: Contains base components for learner portals. library has been deprecated and will be archived by the time of release. @Zach Hancock (Deactivated) to update once that is completed.
A few pieces of the legacy/deprecated learner experience have been removed entirely in favor of the MFE experience. Specifically, the outline, dates, and courseware tabs. Instead, you must run the Learning MFE and its tabs will be used. Along with the legacy code, a few old waffle flags have been removed:
course_experience.latest_update
,course_experience.show_upgrade_msg_on_course_home
,course_experience.upgrade_deadline_message
,course_home.course_home_use_legacy_frontend
,courseware.microfrontend_course_team_preview
, andcourseware.use_legacy_frontend
@Michael Terry (Deactivated)FC-0001: Replace usages enterprise_catalogs Enterprise API V1 by ruzniaievdm · Pull Request #3742 · openedx-unsupported/ecommerce changes the ecommerce application so that it looks at the enterprise-catalog service for catalog information instead of looking at the deprecated v1 catalog api in edx-enterprise.
As a consequence of this change, we read the
enterprise_catalog_api_url
from site configuration so ensure that this setting is set for any site that loads enterprise catalog data. This setting is just a passthrough forsettings.ENTERPRISE_CATALOG_API_URL
which should be loaded into your django settings, however you load that.See FC-0001: Replace usages enterprise_catalogs Enterprise API V1 by ruzniaievdm · Pull Request #3742 · openedx-unsupported/ecommerce for more details.
[Andy Shultz] [DEPR]: Remove Learner View in Insights, Data API, and Pipeline · Issue #36 · openedx/public-engineering The learner view has been removed from Insights and the Data API. It has not yet been entirely removed from the pipeline but learner data is now impossible to access if generated.
https://github.com/openedx/public-engineering/issues/37 : EdxRestApiClient has been deprecated since April, 2019. As of the Olive release, it has been removed. Please use OAuthAPIClient.
https://github.com/openedx/public-engineering/issues/50 The Course Home Outline and Dates tabs have been moved to the frontend-app-learning MFE, under course-home.
If Course Outlines are not displaying on some courses after upgrading, please try running the
backfill_course_outlines
management command.
Other removals/deprecations this release:
https://github.com/openedx/public-engineering/issues/63 (this feature was ultimately not removed: see https://discuss.openedx.org/t/deprecation-removal-verifiedtrackcohort-depr-63/7334/3 )