Document Alyx user permissions system
Open
Nobody has claimed this yet.
doc
enhancement
usability
- Dominant language
- Python
- Stars
- 52
- Forks
- 12
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 4
Description
The Alyx user guide doesn't contain information about user permissions. The follow details would be valuable:
- Definitions of public, staff, superuser, responsible user, object user, lab member, stock manager, and lab manager, as well as their permissions
- How to update user permissions
- How to add a user group
- How to add default superusers in the Alyx settings
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Alyx user guide and inspect the linked alyx/alyx/settings_lab_template.py section for the default superuser configuration. Document the listed user roles and permissions, how to update permissions, how to add a user group, and how to configure default superusers. Done means all four checklist items are covered in the user guide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, python
- Domain
- authorization, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100