Skip to content

[FC-0099] docs: add the default roles and permissions documentation#94

Merged
MaferMazu merged 3 commits intoopenedx:mainfrom
eduNEXT:mfmz/docs-default-roles
Oct 20, 2025
Merged

[FC-0099] docs: add the default roles and permissions documentation#94
MaferMazu merged 3 commits intoopenedx:mainfrom
eduNEXT:mfmz/docs-default-roles

Conversation

@MaferMazu
Copy link
Copy Markdown
Contributor

@MaferMazu MaferMazu commented Oct 14, 2025

Description

This PR adds the documentation about the default roles and permissions available for the content library authorization system.

Related to: #92

How to test

📍Enter https://openedx-authz--94.org.readthedocs.build/en/94/concepts/core_roles_and_permissions/content_library_roles.html to review the content and structure.

Checks

Merge checklist:
Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • 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 the open-source-contribution PR author is not from Axim or 2U label Oct 14, 2025
@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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Oct 14, 2025
@MaferMazu MaferMazu changed the title docs: add the default roles and permissions documentation [FC-0099] docs: add the default roles and permissions documentation Oct 14, 2025
@MaferMazu
Copy link
Copy Markdown
Contributor Author

@gviedma-aulasneo @jmakowski1123 I would appreciate your feedback on the documentation: https://openedx-authz--94.org.readthedocs.build/en/94/concepts/core_roles_and_permissions/content_library_roles.html, principally for a product perspective.

@sarina @Apgomeznext, I would like your feedback too.

@MaferMazu MaferMazu requested a review from Apgomeznext October 14, 2025 15:34
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Oct 15, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Oct 15, 2025
Comment thread docs/concepts/core_roles_and_permissions/content_library_roles.rst Outdated
Comment thread docs/concepts/core_roles_and_permissions/content_library_roles.rst Outdated
@gviedma-aulasneo
Copy link
Copy Markdown

@MaferMazu Small change: replace Author/Collaborator with the new Publisher/Author pair. I’d also present the roles before the Permissions and note that a role is a set of permissions granted to a user for a specific Library Scope, to start onboarding users to the terminology and future AuthZ extensions.

@MaferMazu
Copy link
Copy Markdown
Contributor Author

MaferMazu commented Oct 16, 2025

@MaferMazu Small change: replace Author/Collaborator with the new Publisher/Author pair. I’d also present the roles before the Permissions and note that a role is a set of permissions granted to a user for a specific Library Scope, to start onboarding users to the terminology and future AuthZ extensions.

Only for confirming, I have two questions:

  1. So the old Author will be the Publisher, and the Collaborator will be the Author, right? So the final table will be as follows:
image
  1. The structure you propose is: Roles, Permissions, and the Roles and Permissions Summary table, right?

cc @gviedma-aulasneo

@gviedma-aulasneo
Copy link
Copy Markdown

@MaferMazu, sorry for the mixup.
1.
Author = Author
Collaborator = Contributor

Same Permissions, different name for the role
2. yes

@MaferMazu
Copy link
Copy Markdown
Contributor Author

@gviedma-aulasneo @Apgomeznext this is ready for a re-review.

Doc: https://openedx-authz--94.org.readthedocs.build/en/94/concepts/core_roles_and_permissions/content_library_roles.html

Comment thread docs/concepts/core_roles_and_permissions/content_library_roles.rst Outdated
@gviedma-aulasneo
Copy link
Copy Markdown

@MaferMazu looks great, thank you! ✅

@MaferMazu MaferMazu merged commit 9a1ef17 into openedx:main Oct 20, 2025
14 checks passed
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Oct 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FC Relates to an Axim Funded Contribution project 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.

Libraries MVP Roles and Permissions Investigation and Model Validation

6 participants