Add dev docs about deleting notes & revisions

Fixes #560

Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2021-03-15 11:53:44 +01:00
parent e177d40ba5
commit d7491f0ce0
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3

View file

@ -14,6 +14,15 @@ The software provides two special groups which have no explicit users:
- `everyone` (Describing that everyone who wants to access a note can do if it is enabled in the config.)
- `loggedIn` (Describing all users which are logged in)
## Deleting notes and revisions
- The owner of a note may delete it.
- By default, this also removes all revisions and all files that were uploaded to that note.
- The owner may choose to skip deleting associated uploads, leaving them without a note.
- The frontend should show a list of all uploads that will be affected
and provide a method of skipping deletion.
- The owner of a note may delete all revisions. This effectively purges the edit
history of a note.
## Dev Setup
- Clone backend and frontend in two folders.
- Run `yarn install` in both projects