[Savannah-cvs] [111] HowToAdminThisWiki: add 'Running Locally' section

[Assaf Gordon]

Revision: 111
          
http://svn.sv.gnu.org/viewvc/?view=rev&root=administration&revision=111
Author:   agn
Date:     2014-11-19 01:51:12 +0000 (Wed, 19 Nov 2014)
Log Message:
-----------
HowToAdminThisWiki: add 'Running Locally' section

Modified Paths:
--------------
    trunk/sviki/HowToAdminThisWiki.mdwn

Modified: trunk/sviki/HowToAdminThisWiki.mdwn
===================================================================
--- trunk/sviki/HowToAdminThisWiki.mdwn 2014-11-19 01:10:19 UTC (rev 110)
+++ trunk/sviki/HowToAdminThisWiki.mdwn 2014-11-19 01:51:12 UTC (rev 111)
@@ -204,3 +204,75 @@
     rc6.d/K02zope2.10 -> ../init.d/zope2.10
 
 Maybe we are back in business.
+
+
+Running This Wiki Locally
+-------------------------
+
+To edit and review changes locally (before commiting, or submitting a patch
+to the address@hidden mailing list), install `ikiwiki`
+and checkout the svn repository:
+
+    $ sudo apt-get install ikiwiki
+    $ svn co svn://svn.savannah.gnu.org/administration
+
+The markdown files will be in `./administration/trunk/sviki`:
+
+    $ ls ./administration/trunk/sviki/
+    AboutTranslations.mdwn         MigrationFromSourceForge.mdwn
+    AccessToCVSROOT.mdwn           Mirmon.mdwn
+    AdminSvnImport.mdwn            MirroringExternalRepository.mdwn
+    AnnouncementMailingList.mdwn   ModerationAutomation.mdwn
+    ApprovingSubmission.mdwn       ModifyingGroupType.mdwn
+    ...
+
+
+### Manual wiki rendering
+
+For a one-time (or occasional) wiki rendering, run `ikiwiki` manually:
+
+    $ mkdir /tmp/sviki/
+    $ ikiwiki --verbose --rebuild \
+          ./adminitration/trunk/sviki \
+          /tmp/sviki
+
+The HTML files will be rendered and stored in `/tmp/sviki`.
+
+`--rebuild` should be used if rebuilding the wiki in a new directory, to
+ensure caching of previous rendering are ignored.
+
+The files can be viewed by simply visiting <file:///tmp/sviki/index.html> -
+however, navigation will be slightly problematic as IkiWiki requires a
+`DirectoryIndex` like option which automatically renders `index.html` as the
+default HTML file in a directory.
+
+### Apache configuration
+
+If you have an apache server running locally, the following configuration
+mimics the GNU Savannah settings:
+
+    Alias /maintenance "/tmp/sviki"
+    <Directory "/tmp/sviki">
+        Options Indexes
+        AllowOverride None
+        order deny,allow
+        allow from all
+        DirectoryIndex index.html
+    </Directory>
+
+### Quicker Updates
+
+For quicker rendering, use `ikiwiki` without `--rebuild` - will only update
+the changed files. In this case, it is better to clean the cache once with
+`--clean` and `--rebuild`:
+
+    # Clean the cache (just once)
+    $ ikiwiki --verbose --clean ./adminitration/trunk/sviki /tmp/sviki
+
+    # Rebuild the entire wiki (just once)
+    $ ikiwiki --verbose --rebuild ./adminitration/trunk/sviki /tmp/sviki
+
+After any further changes, just update the relevant files (without `--rebuild`,
+the default `ikiwiki` operation is `--refresh`):
+
+    $ ikiwiki --verbose ./adminitration/trunk/sviki /tmp/sviki