Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

revert: feat: Added XblockMixin for skill tagging #34394

Closed

Conversation

kdmccormick
Copy link
Member

@kdmccormick kdmccormick commented Mar 19, 2024

DRAFT -- This is blocked by #34231.

Description

This reverts commit 0b7e273 , added in:

We remove SkillTaggingMixin from common.py's XBLOCK_MIXINS because:

  • Skill tagging did not go through product review, so its code should
    not be referenced in a core repository like edx-platform.

  • The skill_tagging package is not a listed dependency of
    edx-platform, so it should not be referenced in edx-platform,
    regardless of whether it technically can be imported using a
    try-except clause.

  • Adding new classes to XBLOCK_MIXINS is strongly discouraged
    (although, to be fair, this guidance did not exist when
    SkillTaggingMixin was added; it was SkillTaggingMixin that made
    us realize we needed to add the guidance).

Migration steps for operators

Fortunately, the XBLOCK_EXTRA_MIXINS Django setting exists for
this exact purpose. Site operators who wish to use skill tagging
can do so with these steps.

  1. Install skill_tagging as a private edx-platform requirement.
  2. Set XBLOCK_EXTRA_MIXINS to a list or tuple containing the string:
    'skill_tagging.skill_tagging_mixin.SkillTaggingMixin'

Merge deadline

We will merge this on Tuesday April 16th so that it is fixed before the Redwood cut.

2U devs -- please apply the migration steps to your internal settings and verify ahead of that date. Let us know if you need any help or clarification! We can also merge on an earlier date if that's better--let us know when you're ready.

kdmccormick and others added 5 commits March 19, 2024 15:29
This has been a no-op for a long time anyway, since HierarchyMixin
has been explicitly mixed into XBlock for as long as I remember.

Ref: openedx/XBlock#714
This reverts commit 0b7e273.

We remove SkillTaggingMixin from common.py's XBLOCK_MIXINS because:

* Skill tagging did not go through product review, so its code should
  not be referenced in a core repository like edx-platform.

* The skill_tagging package is not a listed dependency of
  edx-platform, so it should not be referenced in edx-platform,
  regardless of whether it technically can be imported using a
  try-except clause.

* Adding new classes to XBLOCK_MIXINS is strongly discouraged
  (although, to be fair, this guidance did not exist when
   SkillTaggingMixin was added; it was SkillTaggingMixin that made
   us realize we needed to add the guidance).

Fortunately, the XBLOCK_EXTRA_MIXINS Django setting exists for
this exact purpose. Site operators who wish to use skill tagging
can do so with these steps.

1. Install skill_tagging as a private edx-platform requirement.
2. Set XBLOCK_EXTRA_MIXINS to a list or tuple containing the string:
   'skill_tagging.skill_tagging_mixin.SkillTaggingMixin'
@kdmccormick kdmccormick self-assigned this Mar 19, 2024
@kdmccormick kdmccormick changed the title Kdmccormick/revert skill tagging revert: feat: Added XblockMixin for skill tagging Mar 19, 2024
@kdmccormick
Copy link
Member Author

Dupe of: #34530

@kdmccormick kdmccormick deleted the kdmccormick/revert-skill-tagging branch April 29, 2024 17:00
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.

None yet

1 participant