web commit by JamesWestby

[ikiwiki.git] / doc / setup.mdwn

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index b3620fb3ca265fb43c3987810ee3e11d1995ebf9..1669071d6c28c8a71a611245ab73d8c9f4b2e930 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,6 +1,6 @@
 So you want to set up your own wiki using ikiwiki? This tutorial will walk
 So you want to set up your own wiki using ikiwiki? This tutorial will walk

-you through setting up a wiki that is stored in [[Subversion]], [[Git]], or
-[[TLA]], and that has optional support for commits from the web.
+you through setting up a wiki that is stored in [[Subversion]], [[Git]],
+[[TLA]] or [[Mercurial]], and that has optional support for commits from the web.

 
 1. [[Install]] ikiwiki. See [[download]] for where to get it.
 
 
 1. [[Install]] ikiwiki. See [[download]] for where to get it.
 


@@ -18,27 +18,43 @@ you through setting up a wiki that is stored in [[Subversion]], [[Git]], or
                cp /usr/share/ikiwiki/basewiki/index.mdwn .
                git add .
                git commit -m create -a
                cp /usr/share/ikiwiki/basewiki/index.mdwn .
                git add .
                git commit -m create -a

+               # No need to keep files in the master repository; so at this
+               # stage, you may want to remove all files (except .git) to
+               # save disk space.

 
                # TLA
                mkdir /tla
                tla make-archive me@localhost--wiki /tla/wikirepo
                tla my-id "<me@localhost>"
 
 
                # TLA
                mkdir /tla
                tla make-archive me@localhost--wiki /tla/wikirepo
                tla my-id "<me@localhost>"
 

+               # Mercurial
+               hg init /hg/wikirepo
+

 3. Check out the repository to make the working copy that ikiwiki will use.
 
                # Subversion
                svn co file:///svn/wikirepo/trunk ~/wikiwc
                 
                # Git
 3. Check out the repository to make the working copy that ikiwiki will use.
 
                # Subversion
                svn co file:///svn/wikirepo/trunk ~/wikiwc
                 
                # Git

-               git clone /git/wikirepo ~/wikiwc
+               # Create a local clone to save disk space and also to
+               # optimize performance. See git-clone(1).
+               git clone -l -s /git/wikirepo ~/wikiwc

 
                # TLA
                mkdir ~/wikiwc
                cd ~/wikiwc
                tla archive-setup me@localhost--wiki/wiki--0
                tla init-tree me@localhost--wiki/wiki--0
 
                # TLA
                mkdir ~/wikiwc
                cd ~/wikiwc
                tla archive-setup me@localhost--wiki/wiki--0
                tla init-tree me@localhost--wiki/wiki--0

+               # Edit {arch}/=tagging-method and change the precious
+               # line to add the .ikiwiki directory to the regexp.

                tla import
 
                tla import
 

+               # Mercurial
+               # Mercurial uses a single repo approach, so no need to
+               # clone anything. Because the following examples
+               # refer to the ~/wikiwc working copy we symlink it:
+               ln -s /hg/wikirepo ~/wikiwc
+

 4. Build your wiki for the first time.
 
                ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
 4. Build your wiki for the first time.
 
                ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \


@@ -68,6 +84,10 @@ you through setting up a wiki that is stored in [[Subversion]], [[Git]], or
                tla add index.mdwn
                tla commit
 
                tla add index.mdwn
                tla commit
 

+               # Mercurial
+               hg add index.mdwn
+               hg commit -m customised index.mdwn
+

    You can also add any files you like from scratch of course.
 
 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
    You can also add any files you like from scratch of course.
 
 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding


@@ -90,12 +110,13 @@ you through setting up a wiki that is stored in [[Subversion]], [[Git]], or
    that all of these are pointing to the right directories, and read
    through and configure the rest of the file to your liking.
 
    that all of these are pointing to the right directories, and read
    through and configure the rest of the file to your liking.
 

-   If you want to use git, comment out the subversion stuff, uncomment and
-   edit the git stuff.
+   If you want to use something other than subversion, comment out the
+   subversion configuration, and uncomment and edit the configuration for
+   your chosen RCS.

 
    Note that the default file has a block to configure an [[post-commit]] 
    wrapper to update the wiki. You need to uncomment the related block for
 
    Note that the default file has a block to configure an [[post-commit]] 
    wrapper to update the wiki. You need to uncomment the related block for

-   whatever rcs you use and comment out the other rcs blocks.
+   whatever RCS you use and comment out the other rcs blocks.

 
    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
    will set everything up and update your wiki.
 
    When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
    will set everything up and update your wiki.


@@ -109,7 +130,7 @@ you through setting up a wiki that is stored in [[Subversion]], [[Git]], or
 9. Add [[PageHistory]] links to the top of pages. This requires you to have
    setup a repository browser.  For Subversion, you may use [[ViewCVS]] or
    something similar to access your [[Subversion]] repository.  For Git,
 9. Add [[PageHistory]] links to the top of pages. This requires you to have
    setup a repository browser.  For Subversion, you may use [[ViewCVS]] or
    something similar to access your [[Subversion]] repository.  For Git,

-   [[Gitweb]] can be used.
+   [[Gitweb]] can be used, etc.

    
    The `historyurl` setting makes ikiwiki add the links, and in that url,
    "\[[file]]" is replaced with the name of the file to view. So edit
    
    The `historyurl` setting makes ikiwiki add the links, and in that url,
    "\[[file]]" is replaced with the name of the file to view. So edit