Documentation improvement requests

[abought]

Overview

This issue exists to track areas where JamDB documentation is currently thin. This captures first impressions where information was needed while setting up a new project.

Permissions

The documentation describes how to set permissions, but it is not very clear on what the permissions levels entail. Certain edge cases and specialized behavior are also not entirely documented. Examples:

• What can a user with collection-level CREATE permissions do to a specific document they created? (CRU? CRUD?)
• Under what conditions can someone change the owner of a record?
  • Who can make these changes? Who cannot?
  • What does a payload look like to do this?
• What is the meaning of the createdIsOwner field? Who can change this? What is a sample use case?
• The permissions page currently just links to collections and namespaces. It should include language clarifying that there are no document-level permissions (aside from special rules surrounding CREATEs)
  • Can a user still see their own record if they lose CREATE access to a collection? Is there a mechanism to freeze/lock down access after the end of an experiment?

Plugins

The use of plugins is not currently documented, including:

• How to set up a plugin
• What plugins exist/ are currently supported
• How to use email functionality such as password resets
  • Also document the role of sendgrid for this feature, including what configuration is needed, and what custom substitution fields are available (user and token as of [rfr] Send user ID to sendgrid, for optional use by email templates #9 )

Miscellaneous

• The state parameter for collections: when to set it, allowed values, and when it can be set. (sample use case: creating the thumbnails collection)