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

Upgrades platform-plugin-aspects and enables Instructor Dashboard plugin #642

Merged
merged 6 commits into from
Mar 13, 2024

Conversation

pomegranited
Copy link
Contributor

@pomegranited pomegranited commented Mar 10, 2024

Description

Updates the dependencies and settings related to openedx/platform-plugin-aspects#7

Testing instructions

  1. Install this branch to your Tutor virtualenv, and ensure this plugin is enabled.
  2. (optional) change the default dashboard: tutor config save -s ASPECTS_INSTRUCTOR_DASHBOARD_UUID=a4472382-0cb4-4874-8fd9-5eb42aadbf11
  3. Rebuild the openedx image (or openedx-dev if running Tutor dev): tutor images build openedx --no-cache
  4. Restart openedx to use the new image: tutor [dev|local] stop lms cms lms-worker cms-worker && tutor [dev|local] start -d lms cms lms-worker cms-worker
  5. Create a new course in Studio
  6. Add "superset" to the Settings > Advanced Settings > Advanced Module List
  7. Add a new section, subsection, unit
  8. Add a Advanced > Superset Dashboard block to the course
    Ensure that it renders in Studio.
  9. Edit the XBlock to change the Dashboard UUID. Ensure that change renders in Studio.
  10. Publish changes to your course

In LMS:

  1. View the Superset XBlock as a course staff/instructor -- should display dashboard.
  2. View as a student -- should display error message.

Instructor Dashboard:

  1. Check that the instructor dashboard plugin is disabled enabled by default by visiting the LMS Instructor Dashboard. Should be an "Aspects" tab that displays the configured ASPECTS_INSTRUCTOR_DASHBOARD_UUID.
  2. Disable the instructor dashboard plugin: tutor config save -s ASPECTS_ENABLE_INSTRUCTOR_DASHBOARD_PLUGIN=False
  3. As course staff/instructor, visit the Instructor Dashboard. Should no longer be an "Aspects" tab showing.

and updates variables accordingly
which configures the Instructor Dashboard plugin filter when enabled
@openedx-webhooks
Copy link

Thanks for the pull request, @pomegranited! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@@ -41,7 +41,7 @@
(
"OPENEDX_EXTRA_PIP_REQUIREMENTS",
[
"platform-plugin-aspects==0.2.0",
"git+https://github.com/openedx/platform-plugin-aspects.git@jill/migrate-xblock#egg=platform-plugin-aspects==0.3.0",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: update after openedx/platform-plugin-aspects#7 merged

@pomegranited pomegranited requested review from bmtcril and Ian2012 March 10, 2024 04:50
tutoraspects/plugin.py Outdated Show resolved Hide resolved
* changed default to True
* avoid overwriting existing OPEN_EDX_FILTERS_CONFIG
@pomegranited pomegranited changed the title Jill/plugin xblock Upgrades platform-plugin-aspects and enables Instructor Dashboard plugin Mar 12, 2024
@Ian2012 Ian2012 force-pushed the jill/plugin-xblock branch from 3e15b29 to 7648807 Compare March 13, 2024 19:34
@Ian2012 Ian2012 force-pushed the jill/plugin-xblock branch from 287163a to 9ffd73f Compare March 13, 2024 19:49
@Ian2012 Ian2012 merged commit d4ef23b into main Mar 13, 2024
10 checks passed
@Ian2012 Ian2012 deleted the jill/plugin-xblock branch March 13, 2024 20:42
@openedx-webhooks
Copy link

@pomegranited 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants