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

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

Merged
merged 4 commits into from
Sep 26, 2024

Conversation

pomegranited
Copy link
Contributor

@pomegranited pomegranited commented Sep 25, 2024

Description

#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: openedx/modular-learning#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

so users know to use Studio Django Admin instead of the LMS.
since we can't show the warning there
@openedx-webhooks
Copy link

Thanks for the pull request, @pomegranited!

What's next?

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

🔘 Get product approval

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

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 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.

🔘 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

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

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 25, 2024
Copy link
Contributor

@ChrisChV ChrisChV left a comment

Choose a reason for hiding this comment

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

@pomegranited Looks good 👍

  • I tested this: I followed the testing instructions and verify the alert message
  • I read through the code and considered the security, stability and performance implications of the changes.
  • Includes tests for bugfixes and/or features added.
  • Includes documentation
  • Includes fixtures that create objects required for manual testing.

Copy link
Contributor

@navinkarkera navinkarkera left a comment

Choose a reason for hiding this comment

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

@pomegranited 👍

  • I tested this: Verified alert and collection soft-delete events
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

@pomegranited pomegranited merged commit da9adf8 into openedx:main Sep 26, 2024
9 checks passed
@pomegranited pomegranited deleted the jill/warn-collection-admin branch September 26, 2024 00:32
@pomegranited pomegranited changed the title Warn Django Admin users editing Collections [FC-0036] Warn Django Admin users editing Collections [FC-0062] Sep 26, 2024
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.

4 participants