web commit by JoshTriplett: Do not perform your own edits in ikiwiki's working copy.

[ikiwiki.git] / doc / setup.mdwn

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 116501768cd4235f24524068562e30f4db722fc1..860afd6f553df93316219a0c44a7dca95252ea29 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -13,6 +13,9 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
                        SRCDIR=~/wikiwc
                        DESTDIR=~/public_html/wiki/
 
+   Note that ikiwiki owns the working copy directory; do not perform your own
+   edits in ikiwiki's working copy.
+
 3. Create the beginnings of your wiki.
 
    This will create a simple main page for the wiki.
@@ -95,15 +98,19 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
    
    There's little that's ikiwiki specific about these instructions; this is
    just how you put a directory under revision control using the various
-   systems that ikiwiki supports.
+   systems that ikiwiki supports. Note that the .ikiwiki subdirectory is
+   where ikiwiki keeps its state, and should be preserved, but not checked
+   into revision control.
 
    [[toggle id=subversion text="Subversion"]]
    [[toggleable id=subversion text="""
                        REPOSITORY=~/wikirepo
                        svnadmin create $REPOSITORY
-                       svn import $SRCDIR file://$REPOSITORY/trunk -m "initial import"
-                       rm -rf $SRCDIR
-                       svn co file://$REPOSITORY/trunk $SRCDIR
+                       svn mkdir file://$REPOSITORY/trunk -m "create trunk"
+                       cd $SRCDIR
+                       svn co file://$REPOSITORY/trunk .
+                       svn add *
+                       svn commit -m "initial import"
    """]]
    
    [[toggle id=git text="Git"]]
@@ -115,6 +122,7 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
                        cp -a $SRCDIR/* .
                        git add .
                        git commit -m "initial import" -a
+                       mv $SRCDIR/.ikiwiki .
                        rm -rf $SRCDIR
                        git clone -l -s $REPOSITORY $SRCDIR
    """]]
@@ -137,6 +145,9 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
    [[toggleable id=mercurial text="""
                        REPOSITORY=$SRCDIR
                        hg init $REPOSITORY
+                       cd $REPOSITORY
+                       hg add *
+                       hg commit -m "initial import"
    """]]
 
 9. Configure ikiwiki to use revision control.