Skip to content

docs: add verawood rbac docs - #1497

Closed
BryanttV wants to merge 11 commits into
openedx:mainfrom
BryanttV:bav/verawood-rbac-docs
Closed

docs: add verawood rbac docs#1497
BryanttV wants to merge 11 commits into
openedx:mainfrom
BryanttV:bav/verawood-rbac-docs

Conversation

@BryanttV

@BryanttV BryanttV commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Description

  • Adds Verawood release notes for the Roles and Permissions Console and Course Authoring Roles (Course Admin / Course Staff).
  • Adds how-tos for using the console and managing course authoring roles, and updates related educator docs (course team roles, library access, course team members, create library).
  • Adds educator how-to images and required toctree entries so the new pages are included in the build.

BryanttV added 9 commits July 29, 2026 15:10
New page. Covers what's new in the unified console: the Assign Role
wizard, organization-level assignment, and the expanded user audit
view.
New page. Introduces Course Admin/Course Staff under the
authz.enable_course_authoring waffle flag, and documents scope
(course/org/global) and migration behavior between legacy and the
new system.
New page. Step-by-step for assigning and removing Course Admin and
Course Staff from the Roles and Permissions console.
Adds a section for Course Admin/Course Staff under the new system.
Legacy role content (Staff, Limited Staff, Admin, Course Data
Researcher) is unchanged.
Legacy Studio/Instructor Dashboard flow is unchanged. Appends a note
pointing to the new console for installs with it enabled.
…izard

Replaces the old Edit-link-plus-modal flow with the unified Assign
Role wizard shared with course authoring. Drops the stale 3-tab
console description in favor of a link to the canonical console doc.
Replaces 4 library screenshots to match the new console. Page title
and the 'Add users to Libraries' label are unchanged.
Minor fix: Admin corrected to 'Library Admin'. Adds a prerequisite
note (course_creator role or global admin/staff access).
New page. Full reference for the console: Team Members tab, filters,
user audit view, Roles and Permissions tab, and the Assign Role
wizard. Other docs link here instead of repeating this content.
@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 Jul 29, 2026
@openedx-webhooks

openedx-webhooks commented Jul 29, 2026

Copy link
Copy Markdown

Thanks for the pull request, @BryanttV!

This repository is currently maintained by @openedx/wg-maintenance-docs.openedx.org.

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.

@BryanttV
BryanttV requested a review from sarina July 29, 2026 20:56
@BryanttV
BryanttV marked this pull request as ready for review July 29, 2026 20:56
@mariajgrimaldi

mariajgrimaldi commented Jul 30, 2026

Copy link
Copy Markdown
Member

Should we add this as new for verawood? I'm reviewing this but it's pointing to confluence, not sure if that section is not being included as in ulmo anymore

Comment thread source/community/release_notes/verawood/verawood_rp.rst
Comment thread source/community/release_notes/verawood/verawood_rp.rst
Comment thread source/community/release_notes/verawood/verawood_rp.rst
@@ -6,12 +6,12 @@ Manage Library User Access
.. tags:: educator, how-to

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

[curious] why are we changing this file for verawood?

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 guess the UI now calls this "Roles & Permissions console" instead of "Administrative Console"?

Comment thread source/educators/how-tos/use_roles_and_permissions_console.rst
On the Team Members tab, you can see all users with a role assignment on the
courses and libraries you have access to.

.. image:: /_images/educator_how_tos/team_members_tab.png

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This creenshot I think is out of date. Currently, we don't display "global" roles.

Comment thread source/educators/how-tos/use_roles_and_permissions_console.rst
within the filter to find a specific organization. Select one or more to
narrow results.

* The **Role** filter lists all available roles, grouped by global, course, and

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We're not displaying global roles: openedx/frontend-app-admin-console#162

Comment thread source/community/release_notes/verawood/verawood_console.rst
Comment thread source/community/release_notes/verawood/verawood_console.rst
Comment thread source/community/release_notes/verawood/verawood_console.rst
Comment thread source/community/release_notes/verawood/verawood_console.rst
Comment thread source/community/release_notes/verawood/verawood_console.rst
Comment thread source/educators/how-tos/set_up_course/add_course_team_members.rst
Comment thread source/educators/how-tos/use_roles_and_permissions_console.rst
Comment thread source/educators/how-tos/use_roles_and_permissions_console.rst
Comment thread source/community/release_notes/verawood/verawood_rp.rst
@sarina

sarina commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Hey, sorry, I can't make my new PR #1500 merge into this branch because yours is on a fork. I'm going to close this one and make changes over there, especially given time is of the essence here. Please move reviews to #1500

@sarina sarina closed this Jul 30, 2026
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Jul 30, 2026
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: Done

Development

Successfully merging this pull request may close these issues.

4 participants