web commit by JoshTriplett: A few minor revisions.

[ikiwiki.git] / doc / setup.mdwn

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 48f63fa55d1855b28dd61ddd1d9a426f9cf76214..a598ef71678801a0175a78522c6794e227b9bc0e 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,11 +1,13 @@
 This tutorial will walk you through setting up a wiki with ikiwiki.
 
-1. [[Install]] ikiwiki. See [[download]] for where to get it.
+1. [[Download]] and [[install]] ikiwiki.
 
 2. Decide where your wiki's files will go.
 
-   As a wiki compiler, ikiwiki builds a wiki from files in a source
-   directory, and outputs the files to a destination directory.
+   As a wiki compiler, ikiwiki builds a wiki from files in a source directory,
+   and outputs the files to a destination directory.  If you keep your wiki in
+   a version control system, the source directory will contain a working copy
+   checked out from the version control system.
 
    For the purposes of this tutorial, we'll set shell variables
    for these locations, and use those variables in the commands that follow.
@@ -13,6 +15,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.
@@ -40,7 +45,7 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
 
 4. Build your wiki for the first time.
 
-                       ikiwiki --verbose $SRCDIR $DESTDIR --url=http://host/~you/wiki/
+                       ikiwiki --verbose $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/
 
    Replace the url with the real url to your wiki. You should now
    be able to visit the url and see your wiki.
@@ -95,7 +100,9 @@ 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="""
@@ -117,6 +124,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
    """]]
@@ -138,7 +146,6 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
    [[toggle id=mercurial text="Mercurial"]]
    [[toggleable id=mercurial text="""
                        REPOSITORY=$SRCDIR
-                       rm -rf $SRCDIR/.ikiwiki # not for checkin
                        hg init $REPOSITORY
                        cd $REPOSITORY
                        hg add *