Skip to content

Commit

Permalink
build(learner-dashboard): Force dependency on tutor<=16
Browse files Browse the repository at this point in the history
Since Learner Dashboard is now a part of tutor-mfe>=17, deprecate the plugin via:

* A README warning
* Forcing it to depend on Tutor<=16.
  • Loading branch information
arbrandes committed Dec 11, 2023
1 parent 4296853 commit 94b0a50
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
3 changes: 1 addition & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ community:
=================================== ======================================================
Plugin Status (*Experimental*, *Production*, or *Deprecated*)
=================================== ======================================================
tutor-contrib-learner-dashboard-mfe Experimental
tutor-contrib-learner-dashboard-mfe Deprecated
tutor-contrib-library-authoring-mfe Experimental
tutor-contrib-blockstore-filesystem Experimental
tutor-contrib-blockstore-minio Experimental
Expand All @@ -36,7 +36,6 @@ to your deployment environment you would:
cd openedx-tutor-plugins/plugins/<plugin-name>
pip install -e .
tutor plugins enable <plugin-name>
tutor config save
Make sure to check each plugin's README file for more details.

Expand Down
10 changes: 5 additions & 5 deletions plugins/tutor-contrib-learner-dashboard-mfe/README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
learner-dashboard-mfe plugin for `Tutor <https://docs.tutor.overhang.io>`__
===========================================================================

This is an experimental plugin (read: it's not supported officially and is not
recommended for production use) that allows Tutor operators to deploy the new
`Learner Dashboard MFE`_.
THIS PLUGIN IS DEPRECATED: the functionality it provides is now an official
part of `tutor-mfe <https://github.com/overhangio/tutor-mfe.git`__.

This plugin allows Tutor operators to deploy the new `Learner Dashboard MFE`_.

.. _Learner Dashboard MFE: https://github.com/openedx/frontend-app-learner-dashboard

Expand Down Expand Up @@ -46,7 +47,6 @@ To uninstall the plugin from an existing local environment::
tutor local run lms ./manage.py lms waffle_flag --deactivate learner_home_mfe.enabled
tutor local run lms ./manage.py lms waffle_flag --decativate --everyone learner_recommendations.enable_dashboard_recommendations
tutor plugins disable learner-dashboard-mfe
tutor config save
tutor local restart mfe

Developing
Expand All @@ -56,7 +56,7 @@ It is possible to use this plugin to develop the Learner Dashboard MFE as per
`the official tutor-mfe instructions`_. After installing the plugin as
described above, from the parent directory of your Learner Dashboard checkout::

tutor config save --append MOUNTS=./frontend-app-learner-dashboard
tutor mounts add frontend-app-learner-dashboard
tutor dev launch

.. _the official tutor-mfe instructions: https://github.com/overhangio/tutor-mfe#mfe-development
Expand Down
5 changes: 3 additions & 2 deletions plugins/tutor-contrib-learner-dashboard-mfe/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ def load_about():
long_description=load_readme(),
packages=find_packages(exclude=["tests*"]),
include_package_data=True,
python_requires=">=3.7",
install_requires=["tutor"],
python_requires=">=3.8",
install_requires=["tutor>=16.0.0,<17.0.0", "tutor-mfe>=16.0.0,<17.0.0"],
extras_require={"dev": ["tutor[dev]>=16.0.0,<17.0.0"]},
entry_points={
"tutor.plugin.v1": [
"learner-dashboard-mfe = tutor_learner_dashboard_mfe.plugin"
Expand Down

0 comments on commit 94b0a50

Please sign in to comment.