openedx / openedx-learning

GNU Affero General Public License v3.0
5 stars 11 forks source link

Warn Django Admin users editing Collections [FC-0062] #233

Closed pomegranited closed 2 months ago

pomegranited commented 2 months ago

Description

https://github.com/openedx/openedx-learning/pull/229 added Django Admin screens for Collections, but testing revealed issues if Collections are edited in the LMS, due to missed signal handlers in the Studio Search app.

This PR adds warnings shown when editing a Collection, to encourage users to use the Studio Django Admin instead of the LMS. Also removes the configuration that allowed editing Collections from the Django Admin list view (so the warnings on the edit screen will be seen), and improves the "help" text for the "enabled" checkbox.

edit_only_in_studio

Supporting information

Related to: https://github.com/openedx/modular-learning/issues/231 Private-ref: FAL-3809

Testing instructions

  1. Using the API, create a couple collections (python manage.py shell):
    from openedx_learning.authoring import api
    learning_package = api.create_learning_package("FAL-3809", "Learning package for FAL-3809")
    api.create_collection(learning_package.id, "FAL-3809-1", title="Collection 1 for FAL-3809")
    api.create_collection(learning_package.id, "FAL-3809-2", title="Collection 2 for FAL-3809")
  2. View the collection in the Django Admin: (python manage.py runserver), and ensure you can:
    • edit the collections' title and/or description.
    • Note the warning shown.

Deadline

ASAP

openedx-webhooks commented 2 months ago

Thanks for the pull request, @pomegranited!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

:radio_button: Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

:radio_button: Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

:radio_button: Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @axim-engineering. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

:bulb: As a result it may take up to several weeks or months to complete a review and merge your PR.