From c275aed960c739aa6f7c0458d5ba3ab6ba3aa58c Mon Sep 17 00:00:00 2001
From: Attila Tajti <attila.tajti@gmail.com>
Date: Wed, 18 Jan 2017 07:52:08 +0100
Subject: [PATCH] doc: explain how publisher paths work with permanodes

Change-Id: I7ddf1c5f2bc93961fbadba978e65819c0bdf5b24
---
 doc/publishing/README.md | 18 ++++++++++++++++++
 doc/server-config.md     |  3 ++-
 2 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/doc/publishing/README.md b/doc/publishing/README.md
index 17155a5d5..3bb801191 100644
--- a/doc/publishing/README.md
+++ b/doc/publishing/README.md
@@ -25,6 +25,24 @@ configure publishing for an image gallery in the server config
       }
     }
 
+For this to work you need a single permanode with an attribute "camliRoot"
+set to "mypics" which will serve as the root node for publishing.
+
+Suppose you want to publish two permanodes as "foo" and "bar". The root node
+needs the following atributes:
+
+    camliRoot = mypics // must match server-config.json
+    camilPath:foo = sha1-foo
+    camliPath:bar = sha1-bar
+
+where sha1-foo (and sha1-bar) is either a permanode with some camliContent,
+or a permanode with some camliMembers.
+
+This will serve content at the publisher root http(s)://«camlihost:port»/pics/
+but note that publisher hides the contents of the root path.
+Keeping with the example above, it would serve
+http(s)://«camlihost:port»/pics/foo and http(s)://«camlihost:port»/pics/bar .
+
 The parameters for setting up the app's process ("listen", "backendURL", and
 "apiHost") are derived from the Camlistore server's "listen", and "baseURL", but
 should the need arise (e.g. with a proxy setup) they can be specified as well.
diff --git a/doc/server-config.md b/doc/server-config.md
index 764342813..169eb8200 100644
--- a/doc/server-config.md
+++ b/doc/server-config.md
@@ -142,7 +142,8 @@ One can create any permanode with camput or the UI, and set its camliRoot
 attribute to the value set in the config, to use it as the root permanode for
 publishing.
 
-Please see the [publishing README](/doc/publishing/README) if you want to
+Please see the [publishing README](/doc/publishing/README) for further details
+on how to set up permanodes for publishing, or if you want to
 make/contribute more publishing views.