Skip to content

feat: add Instructor Dashboard permissions - #552

Open
mariajgrimaldi wants to merge 1 commit into
MJG/applets-definition-ownershipfrom
MJG/instructor-dashboard-permissions
Open

mariajgrimaldi wants to merge 1 commit into
MJG/applets-definition-ownershipfrom
MJG/instructor-dashboard-permissions

Conversation

@mariajgrimaldi

@mariajgrimaldi mariajgrimaldi commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

Description

Issue #484 asks for permissions for the Instructor Dashboard, which brings together several areas of course administration. Following the ownership rules in ADR 0032, each permission goes to the applet for the bounded context that owns its action or data, so this PR adds three applets:

  • enrollments for viewing enrollments and enrolling or unenrolling learners;
  • learner_grading for the gradebook and the grading tools for individual learners;
  • learner_administration for course information, learner extensions, and cohorts.

Each applet defines its permissions and categories in YAML and adds them to course_admin and course_staff through role extensions, and openedx_authz.constants.permissions re-exports their constants, so clients import them from the same module as the other permissions.

The dashboard also checks three existing Course Authoring permissions, courses.view_course_team, courses.manage_course_team, and courses.view_grading_settings, which this PR leaves unchanged.

The new permissions exist only in the YAML schema, so they reach Casbin through load_authz_schema, which #538 makes the only source of static policies.

Testing instructions

  1. In a Tutor development environment with this branch mounted, run tutor dev run lms ./manage.py lms load_authz_schema --dry-run and check that the "Casbin policies" section adds a row for each of the ten new courses.* permissions for both course_admin and course_staff.
  2. Run the same command without --dry-run.
  3. Assign course_staff to a user in a course, then open tutor dev run lms ./manage.py lms shell and check that is_user_allowed(username, "courses.view_gradebook", course_key) from openedx_authz.api returns True for that user and False for a user without a role in the course.

Merge checklist:
Check off if complete or not applicable:

  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Oct 21, 2026
@openedx-webhooks

openedx-webhooks commented Oct 21, 2026 •

Copy link
Copy Markdown

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @openedx/committers-openedx-authz.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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.

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

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Oct 21, 2026
@mariajgrimaldi
mariajgrimaldi added this pull request to stack #549 October 21, 2026 19:37
@mariajgrimaldi
mariajgrimaldi force-pushed the MJG/instructor-dashboard-permissions branch from bb5a102 to 815967f Compare October 21, 2026 19:44
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Oct 22, 2026
@mariajgrimaldi
mariajgrimaldi force-pushed the MJG/instructor-dashboard-permissions branch from 815967f to 66044f3 Compare October 23, 2026 10:18
@mariajgrimaldi
mariajgrimaldi force-pushed the MJG/instructor-dashboard-permissions branch 2 times, most recently from 35a5429 to c197ec3 Compare October 23, 2026 10:53
@mariajgrimaldi
mariajgrimaldi force-pushed the MJG/instructor-dashboard-permissions branch from c197ec3 to 0fb3a2c Compare October 23, 2026 12:02
@mariajgrimaldi mariajgrimaldi linked an issue Oct 23, 2026 that may be closed by this pull request
4 tasks
@mariajgrimaldi
mariajgrimaldi force-pushed the MJG/instructor-dashboard-permissions branch from 0fb3a2c to 4874519 Compare October 23, 2026 13:00
@mariajgrimaldi
mariajgrimaldi force-pushed the MJG/instructor-dashboard-permissions branch from 4874519 to ee87224 Compare October 23, 2026 13:05
@mariajgrimaldi
mariajgrimaldi marked this pull request as ready for review October 23, 2026 13:08
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

Register Instructor Dashboard permissions in AuthZ (LMS)

3 participants