Part of: https://github.com/openedx/edx-platform/issues/32457 There are two generations of Content Libraries in the platform. The Open edX user interface has referred to them by different names across releases, so to disambiguate, we use the code-names “V1” and “V2”.
V1 Libraries will be removed as soon as Teak. This living document explains how we currently plan to migrate existing V1 Library content and references over to V2.
Release(s) | V1 Libraries | V2 Libraries | |
|---|---|---|---|
Cypress → Nutmeg | Library Authoring Environment | From Studio home, go to theContent Libraries tab, and select an existing library or click + New Content Library.
| Not available |
Course Authoring Environment |
| ||
Configuration | Enabled by default. To disable site-wide, set Django setting | ||
Olive → Redwood | Library Authoring Environment | Same as Cypress → Nutmeg | Not available |
Course Authoring Environment | From the unit editor, simply add a Library Content component. No need to edit Advanced Settings. Otherwise, same as Cypress → Nutmeg | ||
Configuration | Same as Cypress → Nutmeg | ||
Sumac | Library Authoring Environment | Tab has been renamed to Legacy Libraries. Otherwise, same as Olive → Redwood | New Libraries (Beta) tab in Studio home. Select an existing library or click + New Library. Authors will see:
|
Course Authoring Environment | From the unit editor, add a Legacy Library Content component. Still no need to edit Advanced Settings. Existing V1 Library Content instances are now Legacy Library Content instances, with no change in behavior. | From the unit editor, add a Problem Bank (Beta)or Library Content (Beta) component. No need to edit Advanced Settings. Problem Bank: explain Library Content: explain | |
Configuration | Enabled by default. To disable site-wide, either:
| Enabled by default. To disable site-wide, either:
| |
Teak | Library Authoring Environment | Deprecation message | |
Course Authoring Environment | |||
Configuration | |||
Ulmo | Library Authoring Environment | No longer available | |
Course Authoring Environment | |||
Configuration | |||
Verawood → beyond | Library Authoring Environment | No longer available | |
Course Authoring Environment | No longer available | ||
Configuration | No longer available |
Previous Releases: Cypress through
...
Nutmeg
Studio had a feature called Libraries; in essence, they are bare-bones problem banks. These libraries had a very minimal authoring environment. They supported only Problem, Video and Text components. They supported OLX import/export. Library content was stored in MongoDB.To disambiguate across releases, we will call this feature These are V1 Libraries.
The only way to use V1 Library content in a course was to add “library_content" to the course’s Advanced Module List, and then add Randomized Content Block components to the course’s units. Each learner would see a (configurable) number of components, selected from the entire library, and optionally filtered to a particular problem type. To disambiguate across release, we will call this component This is the V1 Library Content Component.
...
A new Libraries (Beta) feature is introduced. It features a much richer authoring environment, allowing authors to organize, tag, sort, and filter their library, and empowering authors to manage a much higher volume of content than would have been suitable in the V1 Libraries environment. It initially supports Problem, Video, and Text components. OLX import/export is not yet supported. Content is stored in MySQL and indexed in Meilisearch. To disambiguate across releases, we’ll call these These are V2 Libraries.
Subsets of V2 Libraries can be randomized into course content via the new Problem Bank component. Subsets of V2 Libraries can be statically shown in courses via a new Library Content component. To disambiguate, we’ll call this These are the V2 Problem Bank Component and V2 Library Content Component, respectively.
...
V1 Libraries and V1 Library Content Components are still available to be used, although there may be warning encouraging authors to use V2 Libraries for all new content.
Provisional Migration Path:From Django Admin, site-global staff will have the option to select one or more V1 Libraries and perform the Migrate Legacy Library to new Library Collection admin action. The staff member will be able to specify any existing V2 Library or V2 Library Collection as the target of the migration.
...
The V1 Libraries authoring environment will no longer be available. In courses, existing V1 Library Content Components will continue working, but they will be unable to receive updates from V1 Libraries.
Migration Plan: The Legacy Libraries tab will show a list of V1 Libraries that are in the system. Libraries that were already migrated to the V2 environment will continue to be indicated as they were in Teak. Libraries that are not yet migrated will feature a prominent “Migrate Now” call-to-action, allowing library authors to select a destination V2 Library or V2 Library Collection.
...