Donation from David Carlier
[ikiwiki.git] / docs / howtos / HowToManageThisSite.mdwn
index 64b25aa..f76e91d 100644 (file)
@@ -2,24 +2,54 @@ This site is managed using ikiwiki.
 
 ## File locations
 
-* The site is located at `/usr/local/www/www.dragonflybsd.org/`
-* The checked out copy from Git used to generate the site is at `/usr/local/www/ikiwiki-srcdir/` (commit here)
-* The bare Git repo for the site is at `/usr/local/www/ikiwiki-repo/` (clone from here)
-* A public copy is available on crater.dragonflybsd.org same as other DragonFly code.
+* `/usr/local/www/ikiwiki-repo.git/` : The bare Git repo for the site. (clone from here)
+* `/usr/local/www/ikiwiki-srcdir/` : The checked out work for site generation. 
+* `/usr/local/www/www.dragonflybsd.org/` Static output from ikiwiki.
 * Source is publically browsable at [gitweb.dragonflybsd.org](http://gitweb.dragonflybsd.org/).
-* configuration file is at `/usr/local/etc/ikiwiki.setup`.
-* Page layouts are at `/usr/pkg/share/ikiwiki/templates/` - page.tmpl is probably the one you want.
-* Stylesheet changes are in `/usr/pkg/share/ikiwiki/basewiki/local.css`.
+* Configuration file is at `/usr/local/etc/ikiwiki.setup`.
+* Page layouts are at `/usr/local/etc/ikiwiki-templates/` - page.tmpl is probably the one you want.  These are just the overrides from /usr/local/share/ikiwiki/templates.  This affects all pages; the sidebar menu is here.
+* Stylesheet changes are in `/usr/local/share/ikiwiki/basewiki/local.css`.
+* After modifying any of the templates or stylesheet info, regenerate the site with `ikiwiki --setup /usr/local/etc/ikiwiki.setup`.
+* Add images by committing them to the repo.
 
-## Making changes
+## Upgrading
 
-* All files under `/doc` can be edited by anyone, as can the `/sandbox` page.
-* Existing developers' accounts can be set to edit the rest of the site; ask on the mailing lists.
-* Changes to the site config are generated into the site with the command `ikiwiki --setup /usr/local/etc/ikiwiki.setup`.
-* To create new pages on the web, add a new wiki link and then follow the link.  If you cannot find a good place for the link, use the [[/sandbox]].
+* Back up `/usr/local/www/ikiwiki-srcdir/`, `/usr/local/www/ikiwiki-repo.git/`, `/usr/local/share/ikiwiki/templates/`, and `/usr/local/etc/ikiwiki.setup`, just to be safe.
+* Save `favicon.ico`, `local.css`, and `style.css` in `/usr/local/share/ikiwiki/basewiki/` separately.  These will need to be restored after upgrade, as they're modified from what comes with the ikiwiki package.  You may also have to save `local.css` and `style.css` in `/usr/local/www/www.dragonflybsd.org/` as well.
+* Upgrade using dports.
+* Run any ikiwiki transition commands mentioned in the release notes at http://ikiwiki.info/news/ .
+* Check for any new plugins that could be enabled; place them in the ikiwiki.setup file.
+* textproc/p5-Search-Xapian and textproc/xapian-omega is needed for the search engine, and the path to the omega CGI listed in ikiwiki.setup, though this should never be needed for a separate install unless rebuilding everything.
+
+Ikiwiki was patched to make sure it would commit changes to git even when no commit message was added.  In /usr/local/lib/perl5/site_perl/5.16/IkiWiki/Plugin/git.pm, change this around line 545:
+
+    # Force git to allow empty commit messages.
+    # (If this version of git supports it.)
+    my ($version)=`git --version` =~ /git version (.*)/;
+    if ($version ge "1.5.4") {
+        push @opts, '--cleanup=verbatim';
+    }
+    else {
+        $params{message}.=".";
+    }
+
+to
+
+    $params{message}.="No commit message specified.";
+
+
+## Feeds
+
+* The sidebar on the main page displays recent headlines from the DragonFly BSD Digest.  
+* Pages are saved to /digest/ and displayed using an 'inline' statement.  \[[!inline pages="internal(digest/*)" feeds="no" template="digestitem"]]
+* The actual feed information is gathered using an aggregate command, kept here so that instructions and actions are in the same place.
+* Don't remove the aggregate command from this page unless you have someplace else for it.
+* Here's the command and output: [[!aggregate  name="DragonFly Digest Feed" dir="digest"
+feedurl="http://www.shiningsilence.com/dbsdlog/feed"
+url="http://www.shiningsilence.com/dbsdlog/" updateinterval="15"
+expireage="14" expirecount="20"]]
 
 ## For more information
 
 * This site contains ikiwiki documentation under /[[ikiwiki]].
-* Markdown is documented at [daringfireball.net](http://daringfireball.net/projects/markdown/syntax).
-* ikiwiki is documented at the [ikiwiki site](http://ikiwiki.info/).
+* For document editing, visit [[How to edit pages on dragonflybsd.org|docs/howtos/How_To_Edit_This_Site]]