document exactly what goes on during a cgi edit or remote commit with git

[ikiwiki.git] / doc / rcs / details.mdwn

diff --git a/doc/rcs/details.mdwn b/doc/rcs/details.mdwn
index 3c9e465c28a76b52261d2c52aed3b0c0fed7afa2..e09fcf75847fe3076029ed6fdb3c8a398c04ab60 100644 (file)
--- a/doc/rcs/details.mdwn
+++ b/doc/rcs/details.mdwn
@@ -150,6 +150,21 @@ Note that, as a rule of thumb, you should always put the rcs wrapper (`post-upda
 into the master repository (`.git/hooks/`) as can be noticed in the Git wrappers of
 the sample [[ikiwiki.setup]].
 
+Here is how a web edit works with ikiwiki and git:
+
+* ikiwiki cgi modifies the page source in the clone
+* git-commit in the clone
+* git push origin master, pushes the commit from the clone to the master repo
+* the master repo's post-update hook notices this update, and runs ikiwiki
+* ikiwiki notices the modifies page source, and compiles it
+
+Here is a how a commit from a remote repository works:
+
+* git-commit in the remote repository
+* git-push, pushes the commit to the master repo on the server
+* the master repo's post-update hook notices this update, and runs ikiwiki
+* ikiwiki notices the modifies page source, and compiles it
+
 ## [[Mercurial]]
 
 The Mercurial backend is still in a early phase, so it may not be mature