Skip to content

docs: add course roles doc#293

Merged
MaferMazu merged 4 commits into
mainfrom
mfmz/course-roles-doc
Jun 2, 2026
Merged

docs: add course roles doc#293
MaferMazu merged 4 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.

Resolves #279

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

Comment thread docs/concepts/core_roles_and_permissions/course_roles.rst
Comment thread docs/concepts/core_roles_and_permissions/course_roles.rst Outdated
Comment thread docs/concepts/core_roles_and_permissions/course_roles.rst Outdated
Comment thread docs/concepts/core_roles_and_permissions/course_roles.rst Outdated
Comment thread docs/concepts/core_roles_and_permissions/course_roles.rst
Copy link
Copy Markdown
Contributor

@rodmgwgu rodmgwgu left a comment

Choose a reason for hiding this comment

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

Looking good!, just please remove the courses.view_global_staff_and_superadmins permission as it's not implemented. I've updated the wiki doc to reflect this. Thanks!

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.

I have no additional comments. Thank you very much!

Copy link
Copy Markdown
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

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

LGTM!

@MaferMazu MaferMazu merged commit 874c734 into main Jun 2, 2026
8 checks passed
@MaferMazu MaferMazu deleted the mfmz/course-roles-doc branch June 2, 2026 21:13
@github-project-automation github-project-automation Bot moved this from In Eng Review to Done in Contributions Jun 2, 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: Done

Development

Successfully merging this pull request may close these issues.

Doc: Adds course roles and permissions in authz doc

6 participants