Skip to content

docs: add course roles doc#293

Open
MaferMazu wants to merge 2 commits into
mainfrom
mfmz/course-roles-doc
Open

docs: add course roles doc#293
MaferMazu wants to merge 2 commits into
mainfrom
mfmz/course-roles-doc

Conversation

@MaferMazu
Copy link
Copy Markdown
Contributor

@MaferMazu MaferMazu commented May 20, 2026

Description

Adds a doc on roles and permissions for courses.

How to test

Review the doc: https://docsopenedxorg--293.org.readthedocs.build/projects/openedx-authz/en/293/concepts/core_roles_and_permissions/course_roles.html and compare it with the roles and permissions in the console or in the wiki page.

@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @MaferMazu!

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 20, 2026
@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions May 20, 2026
Copy link
Copy Markdown
Contributor

@BryanttV BryanttV left a comment

Choose a reason for hiding this comment

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

Thanks @MaferMazu!, I have a few comments

Schedule & Details
===================
- **View schedule** (``courses.view_schedule``): Allows users to view the course schedule.
- **Edit schedule** (``courses.edit_schedule``): Allows users to edit the course schedule.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I was checking these permissions, but I only found the permission courses.view_schedule_and_details. Are both permissions combined into one? Is that how it's supposed to be?

Other
=====
- **View checklists** (``courses.view_checklists``): Allows users to view checklists.
- **View global staff & super admins** (``courses.view_global_staff_and_superadmins``): Allows course admins to view the list of global staff and super admin users.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Will this permission be added later?


- The **Course Editor** can create and edit content within a course but cannot publish it. They support the authoring process while leaving final publishing to Staff or Admins.

- The **Course Auditor** can view and reuse content but cannot edit or delete anything.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Which course permissions would allow content to be reused?


Library Updates
========================
- **Review library updates** (``courses.manage_library_updates``): Allows users to accept or reject library updates in Studio.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **Review library updates** (``courses.manage_library_updates``): Allows users to accept or reject library updates in Studio.
- **Manage library updates** (``courses.manage_library_updates``): Allows users to accept or reject library updates in Studio.


.. _Course Roles:

Roles
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we also mention the legacy roles that were temporarily included?

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions May 20, 2026
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

Status: In Eng Review

Development

Successfully merging this pull request may close these issues.

4 participants