about summary refs log tree commit homepage
path: root/Documentation
DateCommit message (Collapse)
2016-03-05doc: varyus speling fickses
Letz trie 2 uphear liter8
2016-02-24www: support $MESSAGE_ID/R/ endpoint for replies
Setting the "In-Reply-To:" header via mailto: links is not well-supported and should probably not be encouraged unless the client situation improves. So instead, teach users more widely-supported ways of setting the In-Reply-To: header to ensure proper threading of replies.
2016-02-07support smart HTTP cloning
This requires POST and (small file) upload support from the PSGI/Plack web server. CGI.pm is currently not supported with this feature. We'll serve everything git can handle by default for performance in the general case. To avoid introducing cognitive overhead for sysadmins managing existing HTTP backends, we do not introduce new configuration directives. Thus, setting http.uploadpack=false in the relevant git config file for each public-inbox (ssoma) git repo will disable smart HTTP for CPU/memory-constrained systems. Technically we could support http.receivepack to allow posting messages to a public-inbox over HTTP(S), but that breaks the public-inbox model of encouraging users to Cc: everyone. Again, we encourage users to Cc: everyone to reduce the chance of a public-inbox becoming a centralized point of failure/censorship.
2016-02-01doc: misc cleanups and whitespace additions
Add a few newlines for readability (perhaps at the expense of economy). Stop mentioning "Open Source" as it is redundant and "Free Software" fits our goals, better.
2016-01-04use Perl POD instead of pandoc-flavored Markdown
This project is currently implemented in Perl, and pod2man is probably more common among potential users and developers of this project.
2016-01-04doc: add TODO.html to public website
HTML has one major advantage over plain text: <a href=...> links That's about it.
2015-12-26doc: use ".html" instead of ".txt.html" for website
Shorter URLs are easier to read, remember, and more efficient.
2015-09-30README: document NNTP access
That's right, we now have our NNTP server running and are self-hosting a read-only news gateway at: nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
2015-09-06update copyright headers and email addresses
In the future, it should be possible to use this: git ls-files | UPDATE_COPYRIGHT_HOLDER='all contributors' \ UPDATE_COPYRIGHT_USE_INTERVALS=2 \ xargs /path/to/gnulib/build-aux/update-copyright
2015-09-04doc: design_www: more accessibility guidelines
Despite best intentions, things like strike-throughs and italics won't render well and will harm accessibility.
2015-09-01completely revamp URL structure to shorten permalinks
This allows common /m/ links to be used without a prefix, saving 2 precious bytes for permalinks and raw messages. Old URLs continue to redirect.
2015-09-01www: root atom feed is "new.atom" and not "atom.xml"
The MIME type entry for Atom feed relies on "atom", so allow properly-configured static file servers to serve it with the correct Content-Type header.
2015-09-01implement per-thread Atom feeds
This allows users to subscribe to only a single thread with their feed reader without subscribing to the rest of the thread. Update our endpoint notes while we're at it.
2015-08-23.txt links return an mbox instead
This improves compatibility and allows individual messages to be concatenated into an existing mbox without further modifications. "git format-patch" does something similar (but does not do "From " line escaping(!))
2015-08-20misc documentation updates
Threading in Xapian is mostly supported by now; so start documenting things.
2015-08-20replace references to lynx
Table rendering in lynx is crap compared to w3m and links. However, we still use it for filtering HTML since the renderer is otherwise nice...
2015-02-09doc/design_www: remove item for auto-generated links
SpamAssassin queries URI blacklists, so it's probably OK to start generating links in the future...
2014-12-22doc: generate README.html instead of index.html
This allows us to generate links without caring about discoverability and remains reasonably WYSIWYG for folks editing our documentation in their favorite $EDITOR
2014-12-22Documentation/txt2pre: support #fragments and ftp://
Occasionally we'll use these for links.
2014-10-05doc: add TODO to the website
2014-07-02doc/dc-dlvr-spam-flow: link to ssoma, too
Some readers may not be familiar with ssoma internals such as ssoma-rm.
2014-07-02doc/dc-dlvr-spam-flow: include links to relevant projects
Some of these projects are not well known, so link to them to help new users.
2014-07-02doc: remove HTML
Even with txt2pre, the maintenance/discoverability burden is too high and lynx still uses too much memory. Unfortunately, we'll have to keep our INSTALL.html for a while longer on the server since it's linked, but not index.html!
2014-04-26huge refactor of encoding handling
Hopefully this simplifies and corrects our usage of Perl encoding APIs.
2014-04-22fix quoted URL generation in feeds
While we're at it, make sure strange characters are escaped properly in Message-IDs. We'll need tests for all this behavior.
2014-04-21feed: there is only one atom feed, with all messages
This is not a blog. All posts, whether replies or not, carry equal weight.
2014-04-21doc: update design_www and add HACKING file
Document some of the stranger choices I've made.
2014-04-21scripts/dc-dlvr: allow exiting from ~/.dc-dlvr.pre
The ~/.dc-dlvr.pre script for my public-inbox user does this.
2014-04-20use ORIGINAL_RECIPIENT once again
It should be common for a single users to be subscribed to multiple addresses/lists, so we must use the address before alias expansion. This partially reverts commit b949afc9edf89dd494cac6255c78b124d58e11a5
2014-04-19various documentation updates
We have an HTML homepage, OMG!
2014-04-19mda: rename PI_FAILBOX to PI_EMERGENCY
The emergency destination may be Maildir. A Maildir emergency destination is better for volatile data which is written to and deleted-from frequently.
2014-04-19cgi: index pages allow iterating some pagination
This allows WWW readers to slowly page through the entire history of the mailing list.
2014-04-15doc: add notes on scalability
Fortunately, most mailing lists will never grow too large.
2014-04-14doc: fold philosophy into the README
Hopefully this makes the scope and intent of the project clearer.
2014-04-11Documentation/design_notes: more updates
Laziness \o/ (Then impatience and hubris :)
2014-04-10doc/design_www: add 301 URLs
We'll probably support these so they're easier-to-type and share.
2014-04-10cgi: wire up index + tests
Remove the specified /all.html while we're at it, we only have /all.atom.xml because it's convenient for feed readers.
2014-04-09doc/design_www: shorten URLs as much as possible
Message-IDs are extremely long already, so try to keep them short here.
2014-04-09doc: split out philosophy to a different page
Hopefully a little easier to find for clients and not admins running servers. While we're at it, expand design_notes.
2014-04-08design_notes: various updates, including "why git?"
Things to keep in mind when working on this.
2014-04-08doc: various cleanups all around
Most notably, the INSTALL is geared towards potential server admins, whereas the README is also for interested "drive-by" readers.
2014-04-06doc: design_www note /full/ namespace for messages
We serve the short, abridge-quote version by default since it is (unfortunately) common practice to over-quote on mailing lists.
2014-04-05public-inbox-mda: preliminary manpage documentation
This still needs to be fleshed out.
2014-04-05doc: add design documentation for WWW interface
Mainly, start with URL routes since that's what users usually see, first.
2014-03-31design_notes: with philosophy
2014-01-09initial commit