From 6864cdba2bb65069d15d26e0b9af6ade8edd0ec3 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Wed, 5 Feb 2020 22:03:46 -0600 Subject: doc: add data flow diagram using Graph::Easy Maybe this can make it easier for new and potential users to understand what's going on. --- Documentation/flow.txt | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 Documentation/flow.txt (limited to 'Documentation/flow.txt') diff --git a/Documentation/flow.txt b/Documentation/flow.txt new file mode 100644 index 00000000..ac3459e4 --- /dev/null +++ b/Documentation/flow.txt @@ -0,0 +1,32 @@ +# public-inbox data flow +# +# Note: choose either "delivery tools" OR "git mirroring tools" +# for a given inboxdir. Combining them for the SAME inboxdir +# will cause conflicts. Of course, different inboxdirs may +# choose different means of getting mail into them. + + +--------------------+ + | delivery tools: | + | public-inbox-mda | + | public-inbox-watch | + | public-inbox-learn | + +--------------------+ + | + | + v ++----------------------+ +--------------------+ +| git mirroring tools: | git (clone|fetch) && | | +| grok-pull, | public-inbox-index | inboxdir | +| various scripts | ----------------------> | | ++----------------------+ +--------------------+ + | + | + v + +--------------------+ + | read-only daemons: | + | public-inbox-httpd | + | public-inbox-nntpd | + +--------------------+ + +# Copyright 2020 all contributors +# License: AGPL-3.0+ -- cgit v1.2.3-24-ge0c7