whimsical-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject [whimsy] branch master updated: Add some docco
Date Sat, 22 Dec 2018 10:55:15 GMT
This is an automated email from the ASF dual-hosted git repository.

sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/whimsy.git

The following commit(s) were added to refs/heads/master by this push:
     new 6ba5be5  Add some docco
6ba5be5 is described below

commit 6ba5be5a222348548099e30997f2fa6e66998bc3
Author: Sebb <sebb@apache.org>
AuthorDate: Sat Dec 22 10:54:58 2018 +0000

    Add some docco
 www/secretary/workbench/README | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/www/secretary/workbench/README b/www/secretary/workbench/README
index 14ec74e..524f86d 100644
--- a/www/secretary/workbench/README
+++ b/www/secretary/workbench/README
@@ -83,3 +83,21 @@ Model:
   attachment.rb:      representation of an individual attachment, backed by
                       both the mbox file and the YAML file.
+  events.rb:          watches the ARCHIVE directory for changes and handles
+                      system signals. These are converted into events
+                      that are returned by the server /events URL
+                      These are captured by the Javascript and used to request
+                      data updates.
+Design Notes:
+  Sorting and merging; handling deleted entries
+  The GUI can display more than one month's data (it automatically does so at month start)
+  However the data for each month is in separate chunks, so the client Javascript is
+  responsible for sort/merging the responses.
+  Whilst the initial data load can (and does) exclude deleted entries, subsequent data must
+  be merged with the existing data in order to allow for deletion by another session
+  The client also needs to keep track of when entries are deleted in case it is an entry
+  a previous month, as the updated entry won't be returned by the server if the client manually
+  requested an earlier month.

View raw message