search

pressbooks / pressbooks-multi-institution

Tools for managing Pressbooks networks shared by multiple institutions
GNU General Public License v3.0
0 stars 1 forks source link

Create user-facing docs for this plugin #107

Closed tw77 closed 6 months ago

tw77 commented 7 months ago

Create user-facing documentation for network managers and institutional managers using this plugin. We want updated chapters in our network manager guide

Should cover:

for NMs

  1. How to create/edit institutions -- including email domain & assigning IM role
  2. How to assign users
  3. How to assign books
  4. How to filter user list/books list by institution
  5. How to view institution details on stats downloads

for IMs

  1. What the IM role is and why it's useful/desirable
  2. How to use the IM dashboard
  3. how to view user list & administer users
  4. how to view book list & administer books
  5. how to view & download institution stats
tw77 commented 7 months ago

Update: I've drafted an unpublished Part with two unpublished chapters viewable for PB staff with access from https://pressbooks.pub/networkmanagerguide/wp-admin/admin.php?page=pb_organize

The Part is called Use the Shared Network Plugin (preview link here)

The two chapters in it (preview links here and here) are:

To come: info on total numbers shown in the Institution List. Reflection on any other details to include.

The chapter for institutional managers links to existing network manager guide chapters on Books, Users, and Stats pages; we could either present near-identical text and screenshots about each of those pages within the IM-oriented chapter, or we could update those existing chapters with notes differentiating between network manager and IM permissions.

tw77 commented 6 months ago

Technically closed, shared with eCO. Preamble / high-level overview at the beginning of each chapter and for the part will be refined.