Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 TeakUlmo. This living document explains how we currently plan to migrate convert existing V1 Library content and references over to V2. We will update it with higher-fidelity mocks/screenshots over time and eventually transfer this information into the official release notes.

Contents:

Table of Contents
stylenone

...

Content Libraries in upcoming releases

General migration notes

Each V1 Library will be convertible to a collectionwithin a V2 Library. The conversion process will be very straightforward. In general, V1 Library Content references in courses will continue to work seamlessly, whether or not its source material has been converted.

Teak

The authoring environment for V2 Libraries, still known as Libraries (Beta), will have several new features, including but not limited to: support for certain Advanced components, support for Units, Subsections, and Sections; ability to import content from courses; various general UX improvements.

...

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

Sumac->Teak 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 conversion.

...

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:

Teak->Ulmo Migration Path

...

The Legacy Libraries tab will show a list of V1 Libraries that are in the system. V1 Libraries that were already migrated converted to the V2 environment will continue to be indicated as they were in Teak. V1 Libraries that are not yet migrated converted will feature a prominent “Migrate Now” call-to-action, allowing library authors to select a destination V2 Library or V2 Library Collection.

...

In order to eventually remove MongoDB as a dependency of Open edX, there will be a future release where the Legacy Libraries tab is removed and V1 Libraries Content becomes completely unavailable. Operators who wish to preserve their V1 Library contents will need to perform the migration described above before upgrading to such a future release.

We expect that any remaining un-migrated Un-converted V1 Library Content Components will continue working in isolation, but will be unable to receive content updateswill work, with some caveats, depending on technical constraints that may arise during the eventual retirement of MongoDB from the platform stack. The DEPR process will be used to communicate any future change in support level to un-converted V1 Library content.