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.ge | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 Documentation/flow.ge (limited to 'Documentation/flow.ge') diff --git a/Documentation/flow.ge b/Documentation/flow.ge new file mode 100644 index 00000000..27f2bfcb --- /dev/null +++ b/Documentation/flow.ge @@ -0,0 +1,27 @@ +# 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. + +graph { flow: down } + +[delivery tools:\n + public-inbox-mda\n + public-inbox-watch\n + public-inbox-learn] -> [inboxdir] + +[git mirroring tools:\n + grok-pull,\n + various scripts +] -- git (clone|fetch) &&\n + public-inbox-index --> [inboxdir] + +[inboxdir] -> +[read-only daemons:\n + public-inbox-httpd\n + public-inbox-nntpd] + +# Copyright 2020 all contributors +# License: AGPL-3.0+ -- cgit v1.2.3-24-ge0c7