openedx / frontend-app-authoring

Front-end for the Open edX Studio experience, implemented in React and Paragon.
GNU Affero General Public License v3.0
13 stars 72 forks source link

Library Description Field #1042

Open bradenmacdonald opened 4 months ago

bradenmacdonald commented 4 months ago
  1. Building on the https://github.com/openedx/frontend-app-course-authoring/issues/1041 , add an editable "Description" field for each content library.
  2. Update the backend and APIs to support the description field.
  3. Note that only users with "author" or "admin" permission for the library have the requisite CAN_EDIT_THIS_CONTENT_LIBRARY permission; for read-only users, the Description field should be read-only.

Screenshot

bradenmacdonald commented 4 months ago

@ormsbee any updated thoughts on whether we can use LearningPackage.description to store the "description" of content libraries? Or would you prefer we store it on the ContentLibrary model directly?

ormsbee commented 4 months ago

I think it's currently hooked up to use LearningPackage.description. I lean slightly towards keeping it in openedx-learning's publishing app, but I go back and forth on whether it should be a field that's deferred by default or an entirely separate 1:1 model–since LearningPackage is going to be pulled back as part of join operations by almost everything.

bradenmacdonald commented 4 months ago

OK, well for the purposes of this project, we'll just stick with whatever the current approach in openedx-learning is, if that's ok - either way works.