Checks run (2 succeeded)
flake8
passed.
JSHint
passed.
Add documentation for User Roles.
Review Request #15068 — Created May 20, 2026 and updated
This adds documentation for User Roles. While this is a Power Pack feature,
moving forward we'll be consolidating Power Pack documentation into the
Review Board docs base. This follows our plans of unifying things under
just one "product" and will make things easier to find for users.Along with the user roles documentation, this adds a "Useful Data and
Resources" section to the review request approval hook docs that lists
some attributes and resources that are useful for approval hooks. I added
this because I thought it'd be a good place to plug user roles.
Built the docs and viewed them.
| Summary | ID |
|---|---|
| 31d4e0e9e2a24fb8649dd08714af39465263ca75 |
| Description | From | Last Updated |
|---|---|---|
|
Just for correctness, this should probably be UserRole.objects.get(slug='team-lead', local_site=review_request.local_site) |
david
|
|
|
This should be UserRole.objects.for_user. We probably should also mention passing in request here (to get the local site when present) |
david
|
|
|
These headings should probably be promoted one level (i.e. "Useful Data and Resources" should be a sibling of "Common Patterns") |
david
|
|
|
Here too. |
david
|
-
-
Just for correctness, this should probably be
UserRole.objects.get(slug='team-lead', local_site=review_request.local_site) -
This should be
UserRole.objects.for_user.We probably should also mention passing in
requesthere (to get the local site when present) -
These headings should probably be promoted one level (i.e. "Useful Data and Resources" should be a sibling of "Common Patterns")
-