rename hook: instead of modifying the passed-by-name array, return a copy

[git.ikiwiki.info.git] / doc / setup.mdwn

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 7f2661ec06e919df822ab85f295f096eacd06765..89444c9a861e35f5067994bd5b760670db6acce6 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -2,7 +2,7 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
 
 [[!toc ]]
 
 
 [[!toc ]]
 

-## [[Download]] and [[install]] ikiwiki
+## Install ikiwiki

 
 If you're using Debian or Ubuntu, ikiwiki is an `apt-get install ikiwiki` away.
 If you're not, see the [[download]] and [[install]] pages.
 
 If you're using Debian or Ubuntu, ikiwiki is an `apt-get install ikiwiki` away.
 If you're not, see the [[download]] and [[install]] pages.


@@ -46,14 +46,8 @@ Done!
 Now you can go to the url it told you, and edit pages in your new wiki
 using the web interface.
 
 Now you can go to the url it told you, and edit pages in your new wiki
 using the web interface.
 

-You can log in using the wiki user and password (or the openid)
-that you told it to set up earlier. That user is an admin, so you can
-go to the Preferences page and click on "Wiki Setup" to further
-configure the wiki.
-

 (If the web interface doesn't seem to allow editing or login, you may
 (If the web interface doesn't seem to allow editing or login, you may

-need to configure [[apache|tips/apache_cgi]] or 
-[[lighttpd|tips/lighttpd_cgi]].)
+need to configure [[configure_the_web_server|tips/dot_cgi]].)

 
 ## Checkout and edit wiki source
 
 
 ## Checkout and edit wiki source
 


@@ -62,8 +56,8 @@ web for editing pages, and instead using your favorite text editor and
 [[Revision_Control_System|rcs]]. 
 
 To do this, you need to check out a copy of the source to your wiki.
 [[Revision_Control_System|rcs]]. 
 
 To do this, you need to check out a copy of the source to your wiki.

-You should avoid making changes directly to the `srcdir`, as that
-checkout is reserved for use by ikiwiki itself.
+(You should avoid making changes directly to the `srcdir`, as that
+checkout is reserved for use by ikiwiki itself.)

 
 Depending on which [[Revision_Control_System|rcs]] you chose to use,
 you can run one of these commands to check out your own copy of your wiki's
 
 Depending on which [[Revision_Control_System|rcs]] you chose to use,
 you can run one of these commands to check out your own copy of your wiki's


@@ -116,26 +110,24 @@ a working copy checked out from the version control system repository.
 When you used `auto.setup`, ikiwiki put the source directory, destination
 directory, and repository in your home directory, and told you the location
 of each. Those locations were chosen to work without customization, but you
 When you used `auto.setup`, ikiwiki put the source directory, destination
 directory, and repository in your home directory, and told you the location
 of each. Those locations were chosen to work without customization, but you

-might want to move them to different directories. There are three steps to
-this process.
-
-1. Move the destination directory and repository around.
+might want to move them to different directories.

 
 

+First, move the destination directory and repository around.
+   

        % mv public_html/foo /srv/web/foo.com
        % mv foo.git /srv/git/foo.git
 
        % mv public_html/foo /srv/web/foo.com
        % mv foo.git /srv/git/foo.git
 

-2. Create a new source directory checkout. If you moved the repository
-   to a new location, checkouts pointing at the old location won't work,
-   and the easiest way to deal with this is to delete them and re-checkout
-   from the new repository location.
-
+If you moved the repository to a new location, checkouts pointing at the
+old location won't work, and the easiest way to deal with this is to delete
+them and re-checkout from the new repository location.
+   

        % rm -rf foo
        % git clone /src/git/foo.git
 
        % rm -rf foo
        % git clone /src/git/foo.git
 

-3. Edit the setup file. Modify the settings for `srcdir`, `destdir`,
-   `url`, `cgiurl`, `cgi_wrapper`, `git_wrapper`, etc to reflect where
-   you moved things. Remember to run `ikiwiki -setup` after editing the
-   setup file.
+Finally, edit the setup file. Modify the settings for `srcdir`, `destdir`,
+`url`, `cgiurl`, `cgi_wrapper`, `git_wrapper`, etc to reflect where
+you moved things. Remember to run `ikiwiki -setup` after editing the
+setup file.

 
 ## Enjoy your new wiki!
 
 
 ## Enjoy your new wiki!