Bug 37638 - Link permissions to entry in the manual
Summary: Link permissions to entry in the manual
Status: NEW
Alias: None
Product: Koha
Classification: Unclassified
Component: Patrons (show other bugs)
Version: unspecified
Hardware: All All
: P5 - low enhancement
Assignee: Bugs List
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-08-13 20:29 UTC by Lauren Denny
Modified: 2024-08-20 15:17 UTC (History)
4 users (show)

See Also:
GIT URL:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
Circulation function:


Attachments
google sheet with links to the permisisons (100 bytes, text/plain)
2024-08-19 21:41 UTC, Lauren Denny
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Lauren Denny 2024-08-13 20:29:02 UTC
Similar to bug 37624, create a link by the permission that takes you to the manual.  If applicable, it would also be helpful to put a note by the permission if a system preference is required.
Comment 1 Lauren Denny 2024-08-19 21:41:24 UTC
Created attachment 170484 [details]
google sheet with links to the permisisons

I created a list of permissions in Koha 22.11 and went through the manual.  I added links to the manual in both the name of the permission or in the last column if more than one header was used.  I also created a column for system preferences that were connected to the permission with a link to the manual.

I did find some permissions that did not have anything in the manual and highlighted them in bright yellow.  The dark yellow is for things in the manual but doesn't have a direct link from the permissions list.

I don't know if the list of system preferences and how-to instructions are directly connected to the specific permission.  The links are based on what I thought appeared to be connected.  It would take someone with knowledge of the backend to be able to determine what actually was connected to a specific permission.

https://docs.google.com/spreadsheets/d/1PUZf_cdB99oFdH_mS0pLogLS9x1KBBjk2vCNWAk4sko/edit?gid=0#gid=0
Comment 2 Heather Hernandez 2024-08-20 14:15:25 UTC
I'm not quite sure about this--on the one hand, I love links to the manual!  On the other hand, I'm not sure where a good place would be to put a "?" link (for example) without it looking very cluttered.  When I'm working on setting permissions, I like to quickly glance for filled or unfilled boxes, and I find most of the permissions self-evident, so wouldn't find something like this helpful (imagine the underscore is a box):

_ ? Set user permissions
_ ? Place and modify holds for patrons

So if there were "?" links, I'd want them at the far right to not interfere with glancing/navigating checked and unchecked boxes.

I've also found the "Help" links at the top adequate, and the individual permissions don't have anchors--I realize this isn't a *good* argument against doing it, since I'm not a newbie!:)

It is great that things not in the manual are discovered so they can be added!  I would encourage looking at this version of the manual, though:
https://koha-community.org/manual/latest/en/html/
Comment 3 Lauren Denny 2024-08-20 15:17:55 UTC
I wonder if the link to the section in the manual for the 'how-to use section'is on the permission and then a table like this is kept in the manual with the permissions.  It would helpful to know what system preferences are connected to the permission to make it work.

I agree a quick list is helpful in the permission.  This is probably too much info for the permissions page but helpful information when I start using it.