Define Permissions

Bug #1842957 reported by Christopher Burton
66
This bug affects 14 people
Affects Status Importance Assigned to Milestone
Evergreen
Fix Committed
Medium
Unassigned
3.10
Fix Committed
Medium
Unassigned
3.11
Fix Committed
Medium
Unassigned

Bug Description

Many permissions in Evergreen are undefined.
I have been looking to recreate permission groups for my ORG and many permissions description is just the name of the permission again giving no context.

My favourite example: CREATE_LASSO: Definition - CREATE_LASSO
Pretty vague permission and what does a lasso have to do with Evergreen?
Doing some digging I find this bug that tells me more https://bugs.launchpad.net/evergreen/+bug/1815815 but if the definition were present it could be more clear for administrators.

I think we should go through and give each description a definition as they should be added when the permission was added

tags: added: permissions
Changed in evergreen:
status: New → Confirmed
Revision history for this message
Jane Sandberg (sandbergja) wrote :

For anybody who wants to work on this: this recent commit by Chris, Kyle, and Galen is a great example of how to do this: https://github.com/evergreen-library-system/Evergreen/commit/1be684833a4d6cb26e63c3f4aeb79c19e08b74cf

Revision history for this message
Meg Stroup (mstroup) wrote :

A general observation:

When I first started using Evergreen (and to this day!), this happened to me at least once a week. At some point, I started googling "(whatever) Evergreen ILS," and that's how I found definitions for most of these things: "CREATE_LASSO: Definition - CREATE_LASSO evergreen ils," which brought me here: http://docs.evergreen-ils.org/2.1/html/permissions_appendix.html.

it's come up for me when I look at "garnished" accounts and have tried to figure out what a permission is, why it might have been added, and if it's still needed.

For the layperson (me), some of those descriptions are a lot more helpful than others. I wonder if providing some extra language in the documentation would be helpful? I echo what Christopher says: a lot of the descriptions are identical to the name of the permission.

I do feel as if I'm part of the problem, not the solution, in this case :)

tags: added: wishlist
tags: added: documentation
Revision history for this message
Jennifer Weston (jweston) wrote :

Revisiting the old Appendix A - Permissions List from 2.1 came up during 2020 Hack-A-Way documentation session. Same link provided by Meg -- https://docs.evergreen-ils.org/2.1/html/permissions_appendix.html

This is on a list of old stuff that never got asciidoc'd -- so now it's on the to-Antorize list. Definitely needs updating with new permissions and friendly definitions.

I'll instigate conversations in early 2021 to work on updates; if anyone has started this work, please share!

tags: removed: wishlist
Changed in evergreen:
importance: Undecided → Medium
Revision history for this message
Susan Morrison (smorrison425) wrote :

I'm currently working on a permissions overhaul for PINES - it is slow going as I'm testing each permission and providing an udpated description as I find out what it actually does, but happy to share anything I've done so far.

Revision history for this message
Susan Morrison (smorrison425) wrote :

I updated as many of the descriptions as I could into a standard format and would love another set or sets of eyes on these. (I think/hope I removed all permissions only relevant to PINES). I formatted in asciidoc in this Google doc: https://docs.google.com/document/d/1F2xZb9EbJjGhv-QZif0UPp7crDy-gypx5ld7k6qr-Uk/edit?usp=sharing.

Some permissions do still have their name as the description, as I have not been able to confirm what they do exactly. Permissions that were documented as being deprecated, I used 'no longer applicable' as the description.

This list was previously included in the documentation from 2.1 as an appendix, so I can plan to add it as an Appendix C to our current docs, but very open to other suggestions!

Revision history for this message
Susan Morrison (smorrison425) wrote :

Submitted two pull requests through Git:

Permissions List (added as a page in the appendix): https://github.com/evergreen-library-system/Evergreen/pull/234

Updates to Describing your people (linked Permissions list page and updated the language regarding the appendix): https://github.com/evergreen-library-system/Evergreen/pull/233

Changed in evergreen:
assignee: nobody → Susan Morrison (smorrison425)
tags: added: pullrequest
Revision history for this message
Andrea Neiman (aneiman) wrote :

Both PRs merged to main & backported through rel_3_10 - thank you, Susan!

Changed in evergreen:
milestone: none → 3.next
assignee: Susan Morrison (smorrison425) → nobody
status: Confirmed → Fix Committed
tags: added: signedoff
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.