about summary refs log tree commit homepage
path: root/Documentation
DateCommit message (Collapse)
2019-01-20$INBOX/_/text/color/ and sample user-side CSS
Since we now support more CSS classes for coloring, give this feature more visibility.
2019-01-02update and add documentation for repository formats
Remove confusing documentation around ssoma now that we have NNTP and downloadable mbox support. Only lightly-checked for grammar and speling, and not yet formatting. Edits, corrections and addendums expected :>
2018-12-12doc/hosted: add glibc and bug-gnulib mirrors
These have existed for a while, actually, so, we might as well publicize them. While we're at it, add a disclaimer to discourage reliance on single points of failure.
2018-07-29mda: allow configuring globally without spamc support
This reuses some of the configuration from -watch, but remains independent since some configurations will use -watch for some inboxes and -mda for others. The default remains "spamc" for -mda users so nothing changes without explicit configuration. Per-inbox configurations may also be supported in the future.
2018-03-29public-inbox-compact: new tool for driving xapian-compact
Having multiple Xapian partitions is mostly pointless after the initial import. We can compact all the partitions into one while keeping the skeleton separate.
2018-03-29public-inbox-convert: tool for converting old to new inboxes
This should make it easier to let users perform comparisons and migrate to v2 if needed.
2018-03-19index: s/GIT_DIR/REPO_DIR/
No functional changes, yet, but this makes future changes easier-to-read.
2018-02-07update copyrights for 2018
Using update-copyrights from gnulib While we're at it, use the SPDX identifier for AGPL-3.0+ to ease mechanical processing.
2018-01-25doc/design_www: adjust some wording and URLs around CSS
I still hate that CSS is over-used, but colors are useful and perhaps using them for highlighting won't be too bad; but user-supplied colors will ALWAYS be supported.
2017-07-02doc: add ruby-dev mirror to the list of hosted mirrors
It seems Xapian is not prepared for Japanese, unfortunately. https://public-inbox.org/meta/20170702213657.GA5312@dcvr/
2017-06-30doc: add a list of hosted archives for external projects
This will hopefully increase visibility of some archives.
2017-01-02watch: watchspam affects all configured inboxes
If a message is spam in one mailbox, it is spam in all others a particular user/group will care about.
2016-12-26doc: minor updates to design notes
ssoma is not worth marketing, but perhaps our mirror of the git mailing list archives is...
2016-12-17feed: support publicinbox.<name>.feedmax
This allows users to customize by using smaller or larger Atom feeds than the default value of 25 entries.
2016-12-12doc: simplify makefile snippet
We have these manpages, and will always have them, so stop trying to pretend we're doing something about maintainability, here.
2016-09-08doc: document PERL_INLINE_DIRECTORY usage
For now, we will document this since it allows better performance without the burden of extensions. Perhaps one day far in the future Perl can natively support vfork(2) AND that version of Perl will be widely available, but I suspect that day is at least a decade away, if not two: https://rt.perl.org/Ticket/Display.html?id=128227
2016-09-07doc: flesh out public-inbox-index documentation
And include it into the build + website
2016-09-07doc: new docs for user-level commands
Hopefully more folks can download and run public-inbox, nowadays.
2016-08-31doc: set release and section properly for manpages
This will be important as we will have more of them.
2016-08-31txt2pre: allow overriding title via env
This will allow reasonable titles to be generated for manpages.
2016-08-31txt2pre: use public-inbox internal APIs
Since this is bundled with the source, we might as well use internal APIs to avoid having duplicate code (and bugs :P)
2016-08-21doc: avoid conflicting with MakeMaker variable names
We want the pod2man(1) executable for handling certain options. Also, use the correct year while we're at it :P
2016-08-21avoid spaces after shell redirection operators
This makes us closer to git.git style (though I'm not quite sure why we do this...)
2016-08-21doc: mda: remove vestigial pandoc comment
We use perlpod nowadays since it's Perl, like our code base.
2016-08-16HACKING: minor updates and add to the website
Also, at least add one of the Tor mirrors (the rest will be discoverable through the mirrors themselves).
2016-07-01git: allow cloning from the URL root, too
This means we can still show non-git users a somewhat browseable URL with a link to the README.html file while allowing git users to type less when cloning. All of the following are supported: git clone https://public-inbox.org/ public-inbox git clone https://public-inbox.org/public-inbox git clone https://public-inbox.org/public-inbox.git torsocks git clone http://ou63pmih66umazou.onion/public-inbox
2016-07-01update git repo location to https:// using GitHTTPBackend.pm
Might as well eat our own dogfood...
2016-06-17TODO: remove cookies for colors
It would be too much of a burden for caching system when user-supplied CSS is more powerful.
2016-06-17doc: update design_www.txt for reply view
Followup-to: 1365e185d817cdc2de04968c37f597d92226a13b ("view: inline message reply into message view")
2016-05-29txt2pre: remove CGI.pm dependency
It's no longer a part of the stock Perl distribution, and we don't need a whole module for just one function.
2016-05-14rename most instances of "list" to "inbox"
A public-inbox is NOT necessarily a mailing list, but it could serve as an input point for zero, one, or infinite mailing lists :D
2016-04-27import: document API for public consumption
This is probably trivial enough to be final?
2016-04-25remove ssoma dependency
By converting to using ourt git-fast-import-based Import module. This should allow us to be more easily installed.
2016-04-15www: redirect /$MESSAGE_ID/f/ endpoints
Quote-folding was a major design mistake pre-1.0. Since this project is still in its infancy and unlikely to be in wide use at the moment, redirect the /f/ endpoints back to the plain message.
2016-04-15doc: update design notes on WWW development
Start documenting our anchors and CSS classes for in case users want to write their own CSS or even JavaScript for local usage.
2016-04-13www: stop generating /$MESSAGE_ID/f/ links
Quote-folding can be detrimental as it fails to hide the real problem of over-quoting. Over-quoting wastes bandwidth and space for all readers, not just WWW readers of the public-inbox. So hopefully removing quote-folding support from the WWW interface can shame those repliers into quoting only relevant portions of what they reply to.
2016-03-05doc: add contact/see-also/copyright sections to mda manpage
We need manpages before we can expect people to install this.
2016-03-05doc: language-neutral client-side endpoints
Be less specific, client-side code can be written in any language (and I do not care for JS runtimes implemented in C++ :P).
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.