-
Notifications
You must be signed in to change notification settings - Fork 91
docs: add verawood rbac docs #1497
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
b4c6444
docs: add Roles and Permissions Console release notes for Verawood
BryanttV cb5f9ec
docs: add Course Authoring Roles release notes for Verawood
BryanttV 1be5fb4
docs: add Manage Course Authoring Roles how-to
BryanttV 1dbf14f
docs: document new course authoring roles in Guide to Course Team Roles
BryanttV 5766296
docs: note new console option in Add Course Team Members
BryanttV 48d8779
docs: update Manage Library User Access for the unified Assign Role w…
BryanttV de3d273
docs: fix role name and add prerequisite note in Create New Library
BryanttV 1b9b250
docs: add canonical Use Roles and Permissions Console how-to
BryanttV 3a6c8f9
docs: add new images for educator how-tos on roles and permissions
BryanttV b3a312d
docs: add verawood console and course authoring roles pages to toctrees
BryanttV 9b451ee
docs: enhance Course Team Roles documentation with formatting updates
BryanttV File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+98 KB
source/_images/educator_how_tos/library_team_roles_assign_save copy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+51.6 KB
source/_images/educator_how_tos/library_team_roles_edit_user_screen copy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+13.3 KB
source/_images/educator_how_tos/studio_home_roles_and_permissions_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
source/community/release_notes/verawood/verawood_console.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| .. _Verawood Roles and Permissions Console: | ||
|
|
||
| Roles and Permissions Console | ||
| ############################################ | ||
|
|
||
| .. image:: /_images/educator_how_tos/console_course_team_members.png | ||
| :alt: The Team Members tab of the Roles and Permissions console, listing role assignments across libraries and courses | ||
| :width: 800 | ||
|
|
||
| The Verawood release upgrades the Roles and Permissions console, | ||
| letting you manage user access across multiple parts of the platform | ||
| from a single view. | ||
|
sarina marked this conversation as resolved.
|
||
|
|
||
| You can now assign a role to one or multiple users, and apply it to | ||
| one or multiple spaces, all in a single action. Verawood also adds | ||
| organization-level assignment. Granting a role to a user at the | ||
| organization level covers not only what exists today, but everything | ||
| created in that organization afterward. | ||
|
sarina marked this conversation as resolved.
|
||
|
|
||
| This is the same console already used for libraries. With Verawood, | ||
|
sarina marked this conversation as resolved.
|
||
| course authoring also lives here too, if enabled — see | ||
| :ref:`Verawood Course Authoring Roles`. | ||
|
sarina marked this conversation as resolved.
|
||
|
|
||
| .. _Verawood Console Available: | ||
|
|
||
| What's Available in Verawood | ||
| ***************************** | ||
|
|
||
| * **Unified interface**: shows all role assignments in one place, | ||
| filterable by role, organization, and scope. | ||
|
|
||
| * **Assign Role wizard**: assign a role to multiple users and multiple | ||
| scopes in a single action. | ||
|
|
||
| * **Organization-level assignment**: grant a role to a user across an | ||
| entire organization, including scopes created later. | ||
|
|
||
| * **User audit view**: shows a user's roles across every course and | ||
| library you have permission to manage. | ||
|
|
||
| * **Filtered entry points**: the console opens filtered to the context | ||
| you came from, unfiltered from the Studio home page, or filtered to | ||
| a single course or library when opened from there. | ||
|
|
||
| Not Affected by This Release | ||
| ***************************** | ||
|
|
||
| * Course content and how it is authored. The console changes how course | ||
| teams and library teams are managed, not what authors create. | ||
|
|
||
| * :ref:`Legacy Libraries <Legacy Content Libraries Overview>` that have | ||
| not yet been migrated to Content Libraries. | ||
|
sarina marked this conversation as resolved.
|
||
|
|
||
| * LMS features outside of role assignment, such as grading, cohorts, | ||
| groups, and discussion forums. | ||
|
sarina marked this conversation as resolved.
|
||
|
|
||
| * Whether course authoring roles are available for a given course, | ||
| which depends on the Course Authoring waffle flag; see | ||
| :ref:`Verawood Course Authoring Roles`. | ||
|
|
||
| .. seealso:: | ||
|
|
||
| :ref:`Verawood Course Authoring Roles` (release notes) | ||
|
|
||
| :ref:`Manage Course Authoring Roles` (how-to) | ||
|
|
||
| :ref:`Add users to Libraries` (how-to) | ||
|
|
||
| :ref:`Guide to Course Team Roles` (reference) | ||
|
|
||
|
|
||
| **Maintenance chart** | ||
|
|
||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | Review Date | Working Group Reviewer | Release |Test situation | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | [DATE] | [REVIEWER] | Verawood | [PASS/FAIL] | | ||
|
sarina marked this conversation as resolved.
|
||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
117 changes: 117 additions & 0 deletions
117
source/community/release_notes/verawood/verawood_rp.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| .. _Verawood Course Authoring Roles: | ||
|
|
||
| Course Authoring Roles and Permissions | ||
| ############################################ | ||
|
|
||
| .. image:: /_images/educator_how_tos/console_course_team_members.png | ||
| :alt: The Team Members tab of the Roles and Permissions console, showing course team members | ||
| :width: 800 | ||
|
|
||
| With Verawood, course authoring joins the Roles and Permissions console | ||
| already used for content libraries. Course team management now also | ||
| uses the same assignment and permission patterns as libraries, | ||
| available through the same console (see | ||
| :ref:`Verawood Roles and Permissions Console`). | ||
|
|
||
| Course Admin and Course Staff are the new system's equivalents of the | ||
| legacy Admin and Staff roles for a course: same responsibilities, new | ||
| assignment mechanism. | ||
|
|
||
| This feature is opt-in: the Course Authoring waffle flag is disabled by | ||
| default and can be enabled per platform, organization, or course. See | ||
| `Enabling the Feature`_ below for setup instructions. | ||
|
|
||
| .. _Verawood Authoring Roles Available: | ||
|
|
||
| Roles | ||
| ***** | ||
|
|
||
| * **Course Admin** — the new-system equivalent of the legacy Admin | ||
| role: course team management through the Roles and Permissions | ||
| console and full authoring access in Studio. | ||
|
|
||
| * **Course Staff** — the new-system equivalent of the legacy Staff | ||
| role: full course lifecycle management in Studio. | ||
|
|
||
| For a full breakdown of what each role can do, see | ||
| :ref:`Course Authoring Roles Under the New Roles and Permissions System <New System Course Authoring Roles>`. | ||
|
|
||
| Scope and Impact | ||
| **************** | ||
|
|
||
| While this feature is enabled, the platform supports both the legacy | ||
| Instructor Dashboard roles (Admin, Staff, Limited Staff) and the new | ||
| Course Admin / Course Staff roles at the same time. New roles apply | ||
| according to the scope where the flag is enabled — platform, | ||
| organization, or course. | ||
|
sarina marked this conversation as resolved.
|
||
|
|
||
| The Roles and Permissions console shows and lets you act on | ||
| course-authoring roles only for the specific courses and organizations | ||
| where the Course Authoring flag is actually enabled — not simply | ||
| because it's enabled somewhere else in your access. Turning the flag | ||
| on or off also triggers a migration of role assignments behind the | ||
| scenes: for a single course or organization this can happen | ||
| automatically, depending on your site's configuration, but a | ||
| platform-wide change always requires your site operator to run the | ||
| migration manually. Until that migration finishes, there can be a | ||
| brief window where a role assignment does not yet reflect the current | ||
| flag state. This is expected during a flag transition — if it doesn't | ||
| resolve on its own, check with your site operator. | ||
|
|
||
| Enabling the Feature | ||
| ********************* | ||
|
|
||
| Disabled by default. Can be enabled at the platform, organization, or | ||
| course level. See the operator release notes: | ||
| https://openedx.atlassian.net/wiki/spaces/OEPM/pages/6331662350/RBAC+AuthZ+for+Course+Authoring+-+Operator+Release+Notes#Enabling-the-Feature-Flag | ||
|
sarina marked this conversation as resolved.
|
||
|
|
||
| Migration of Existing Course Role Assignments | ||
| ********************************************** | ||
|
|
||
| Verawood includes migration tools to synchronize existing Admin and | ||
| Staff course role assignments between the legacy system and Roles and | ||
| Permissions. Depending on how your site is configured, this can happen | ||
| automatically when the Course Authoring flag is turned on for a course | ||
| or organization — existing Admin and Staff assignments carry over to | ||
| the new system without manual steps. If automatic migration isn't | ||
| enabled on your site, your site operator can run the migration | ||
| separately. Either way, no role assignments are lost in the process. | ||
|
|
||
| Future Improvements | ||
|
sarina marked this conversation as resolved.
|
||
| ******************* | ||
|
|
||
| The Course Authoring waffle flag is expected to default to enabled at | ||
| the platform level in a future release (timeline not yet committed). | ||
|
|
||
| After Verawood, the Roles and Permissions work is expected to continue | ||
| in several directions: | ||
|
|
||
| New Studio roles are planned to separate authoring responsibilities | ||
| from managing an active course, and to introduce a read-only role for | ||
| reviewing course content in Studio without edit access. | ||
|
|
||
| Roles and Permissions will also expand to the LMS, bringing the same | ||
| model to learner-facing features and runtime course management. | ||
|
|
||
| Documentation with design patterns, guides, and extension points for | ||
| the community to build on top of the new system are also on the | ||
| roadmap. | ||
|
|
||
| .. seealso:: | ||
|
|
||
| :ref:`Verawood Roles and Permissions Console` (release notes) | ||
|
|
||
| :ref:`Manage Course Authoring Roles` (how-to) | ||
|
|
||
| :ref:`Guide to Course Team Roles` (reference) | ||
|
|
||
| :ref:`Add Course Team Members` (how-to) | ||
|
|
||
|
|
||
| **Maintenance chart** | ||
|
|
||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | Review Date | Working Group Reviewer | Release |Test situation | | ||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
| | [DATE] | [REVIEWER] | Verawood | [PASS/FAIL] | | ||
|
sarina marked this conversation as resolved.
|
||
| +--------------+-------------------------------+----------------+--------------------------------+ | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.