X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fdesign_notes.txt;h=e871f4c85672cc36b3d720ffc2d80a49b086325a;hb=4f1a683dc895a7bd4cf79e58b39faea256045921;hp=5da48b5dcc2b302e0267eacea43d1e0ae5336cca;hpb=209476bb4cf497810564eb764e93854504a3aa6d;p=public-inbox.git
diff --git a/Documentation/design_notes.txt b/Documentation/design_notes.txt
index 5da48b5d..e871f4c8 100644
--- a/Documentation/design_notes.txt
+++ b/Documentation/design_notes.txt
@@ -27,9 +27,7 @@ Use existing infrastructure
* Existing spam filtering on an SMTP server is also effective on
public-inbox.
-* readers may continue using use their choice of mail clients and
- mailbox formats, only learning a few commands of the ssoma(1) tool
- is required.
+* Readers may continue using use their choice of NNTP and mail clients.
* Atom is a reasonable feed format for casual readers and is supported
by a variety of feed readers.
@@ -56,7 +54,8 @@ Why email?
* git, one of the most widely-used version control systems, includes many
tools for for email, including: git-format-patch(1), git-send-email(1),
git-am(1), git-imap-send(1). Furthermore, the development of git itself
- is based on the git mailing list.
+ is based on the git mailing list: https://public-inbox.org/git/
+ (or http://hjrcffqmbrq6wope.onion/git/ for Tor users)
* Email is already the de-facto form of communication in many Free Software
communities..
@@ -86,6 +85,11 @@ Why perl 5?
* git and SpamAssassin both use it, so it should be one less thing for
admins to install and waste disk space with.
+* Distributing compiled binaries has higher costs for storage/cache
+ space is required for each architecture. Having a runnable,
+ source-only distribution means any user already has access to all
+ of our source.
+
Laziness
--------
@@ -112,12 +116,11 @@ Laziness
* Avoids bikeshedding about web UI decisions, GUI-lovers can write their
own GUI-friendly interfaces (HTML or native) based on public archives.
- Maybe one day integrated MUAs will feature built-in git protocol support!
Web notes
---------
-* Getting users to install/run ssoma (or any new tool) is difficult.
+* Getting users to install/run any new tool is difficult.
The web views must be easily read/cache/mirror-able.
* There may also be a significant number of webmail users without
@@ -126,7 +129,7 @@ Web notes
* Expose Message-ID in web views to encourage replies from drive-by
contributors.
-* Raw text endpoint allows users to write client-side JS endpoints
+* Raw text endpoint allows users to write client-side endpoints
without hosting the data themselves (or on a different server).
What sucks about public-inbox
@@ -140,19 +143,11 @@ What sucks about public-inbox
Scalability notes
-----------------
-Even with shallow clone, storing the history of large/busy mailing lists
-may place much burden on subscribers and servers. However, having a
-single (or few) refs representing the entire history of a list is good
-for small lists since it's easier to look up a message by Message-ID, so
-we want to avoid splitting refs with independent histories.
-
-ssoma will likely grow its own built-in ref rotation system based on
-message count (not rotating at fixed time intervals). This would
-split the histories and require O(n) lookup time based on Message-ID,
-where `n' is the number of history splits.
+See the public-inbox-v2-format(5) manpage for all the scalability
+problems solved.
Copyright
---------
-Copyright 2013-2015 all contributors
-License: AGPLv3 or later
+Copyright 2013-2020 all contributors
+License: AGPL-3.0+