IQSS / IQSS/dataverse

Groups Documentation for admins: merge scattered info into single guide page

Open
#6,992 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: Admin Guide User Role: Sysadmin
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

As discussed with @pdurbin on IRC, this issue is about making all information about group administration appear in one place of the admin guide.

Currently, admins will have to dig out all the informations scattered across the guides or even need to look deep in API guide or code for explicit groups.

This will need to merge or reference to:

  • IP groups
  • Global explicit groups (see #2412)
  • Mail Domain groups (see #6936)
  • Shibboleth groups

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the admin guide sections and the related material in the other guides, API guide, and code for IP, global explicit, mail domain, and Shibboleth groups. Review issues #2412 and #6936 for the referenced group behavior. Done means admins can find complete group-administration information in one guide page, with clear references where appropriate.

Written by the indexing model from the issue text.

Assessment

Domain
authorization, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.