Skip to content

feat!: remove library_sourced block - #33257

Merged
kdmccormick merged 1 commit into
openedx:masterfrom
kdmccormick:kdmccormick/rm-library-sourced
Sep 15, 2023
Merged

feat!: remove library_sourced block#33257
kdmccormick merged 1 commit into
openedx:masterfrom
kdmccormick:kdmccormick/rm-library-sourced

Conversation

@kdmccormick

@kdmccormick kdmccormick commented Sep 14, 2023

Copy link
Copy Markdown
Member

Originally, we planned to add support for V2 libraries and for static
(hand-selected) library block reference via new block type: library_sourced.

We have since decided that it would be better to add those capabilities
in-place to the existing library_content block. This will ease V1->V2
library migration and make adoption of the new features easier for current
library users. It will also avoid duplication of logic between two block types,
we we fear would be error-prone. For details, see this ADR:
#33231

So, we are removing the library_sourced block.
This block has existed in edx-platform for a few years now, but was not
enabled by default and never officially supported. It was only usable via the
experimental V2 content library feature. Operators who added library_sourced
blocks to their course will now see them render as HiddenBlock instances, i.e.:

ERROR: "library_sourced" is an unknown component type...

This should not impact other component types in such courses and should not
impact import/export.


What HiddenBlock looks like in Studio:

image

@kdmccormick
kdmccormick force-pushed the kdmccormick/rm-library-sourced branch from c5ab89c to fbcd07c Compare September 14, 2023 17:28
@kdmccormick
kdmccormick marked this pull request as ready for review September 14, 2023 19:42

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

Let's merge tomorrow morning for the sake of on-call, but looks good!

Rather than implementing V2-library and static-library-reference support
in a new block, we will be enhancing the existing `LibraryContentBlock`
in-place.

Relevant ADR PR: openedx#33231
@kdmccormick
kdmccormick force-pushed the kdmccormick/rm-library-sourced branch from fbcd07c to d81d774 Compare September 14, 2023 21:52
@kdmccormick kdmccormick changed the title feat!: remove LibrarySourcedBlock feat!: remove library_sourced block Sep 15, 2023
@kdmccormick
kdmccormick merged commit 265701c into openedx:master Sep 15, 2023
@kdmccormick
kdmccormick deleted the kdmccormick/rm-library-sourced branch September 15, 2023 14:05
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

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

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

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

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants