Update example ikiwiki configuration
authorMichael Meffie <mmeffie@sinenomine.net>
Thu, 28 Jun 2018 21:23:52 +0000 (17:23 -0400)
committerMichael Meffie <mmeffie@sinenomine.net>
Thu, 28 Jun 2018 21:23:52 +0000 (17:23 -0400)
The ikiwiki default for the --usedirs options now defaults to true, and
the site now builds with the usedirs option. Update the instructions for
creating a local site for previewing changes to fix the links on the
preview site.

devel/GitWiki.mdwn

index 59c8c6c..f3b3d51 100644 (file)
@@ -71,7 +71,7 @@ See [[ikiwiki downloads|http://ikiwiki.info/download]] for installation
 instructions for other various platforms.
 
 Create a minimal ikiwiki configuration file by saving the following in
-the file '~/openafs-wiki.setup' (where `<username>` is your username)
+the file '~/openafs-wiki.setup',  where `<username>` is your username:
 
     use IkiWiki::Setup::Standard {
         wikiname => 'openafs-wiki',
@@ -79,14 +79,16 @@ the file '~/openafs-wiki.setup' (where `<username>` is your username)
         destdir => '/home/<username>/public_html/openafs-wiki',
         url => 'http://localhost/openafs-wiki/',
         rcs => '',
-        usedirs => 0,
+        usedirs => 1,
            add_plugins => [qw{goodstuff}],
     }
 
 The 'srcdir' should reference your local openafs-wiki git repository, created
 by the git clone. The 'destdir' will be created by ikiwiki when the pages are
-generated for preview. Note the 'rcs' setting is intentionally left empty in
-this setup.
+generated for preview. The 'destdir' may be set to a DocumentRoot directory if
+you have a local http server to show the pages.
+
+Note the 'rcs' setting is intentionally left empty in this setup.
 
 The html files can now be generated from the openafs-wiki source by 'ikiwiki'.
 Run the following command to create the 'destdir' directory and create the
@@ -110,7 +112,7 @@ the source files.
 
 To preview a page, point your browser at:
 
-    file:///home/<username>/public_html/openafs-wiki/<NameOfPage>.html
+    file:///home/<username>/public_html/openafs-wiki/
 
 When you are satified with your changes, use `git add` and `git commit` to
 create a commit to be submitted, then to publish your changes on the wiki, push