From c01eb61f196423842f6bb1d5d04bd29ee0bca170 Mon Sep 17 00:00:00 2001 From: David Mehren Date: Mon, 15 Mar 2021 11:53:44 +0100 Subject: [PATCH] Add dev docs about deleting notes & revisions Fixes #560 Signed-off-by: David Mehren --- docs/content/dev/2.0.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/content/dev/2.0.md b/docs/content/dev/2.0.md index fe3f13ba1..6b92657c7 100644 --- a/docs/content/dev/2.0.md +++ b/docs/content/dev/2.0.md @@ -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