docs/howtos/HowToManageThisSite.mdwn

   1 This site is managed using ikiwiki.
   2
   3 ## File locations
   4
   5 * `/usr/local/www/ikiwiki-repo.git/` : The bare Git repo for the site. (clone from here to work on your own copy to commit back)
   6 * `/usr/local/www/ikiwiki-srcdir/` : The checked out work for site generation.  Ikiwiki uses this; shouldn't need to be touched.
   7 * `/usr/local/www/www.dragonflybsd.org/` Static output from ikiwiki.  This is the final output from site generation.  Any changes will be overwritten on the next generation of the site.
   8 * Source is publically browsable at [gitweb.dragonflybsd.org](http://gitweb.dragonflybsd.org/).
   9 * Configuration file is at `/usr/local/etc/ikiwiki.setup`.
  10
  11 ## Making changes
  12
  13 * Edit pages directly.
  14 * 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.
  15 * Stylesheet changes go in `/usr/local/share/ikiwiki/basewiki/local.css`.
  16 * Add images by committing them to the repo.
  17 * After modifying any of the templates or stylesheet info, regenerate the site with `ikiwiki --setup /usr/local/etc/ikiwiki.setup`.
  18
  19 ## Upgrading
  20
  21 * 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.
  22 * 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.  Hint: use /root/adm/ikiwiki-backup.
  23 * Upgrade using dports.
  24 * Run any ikiwiki transition commands mentioned in the release notes at http://ikiwiki.info/news/ .
  25 * Check for any new plugins that could be enabled; place them in the ikiwiki.setup file.
  26 * 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.
  27
  28 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:
  29
  30     # Force git to allow empty commit messages.
  31     # (If this version of git supports it.)
  32     my ($version)=`git --version` =~ /git version (.*)/;
  33     if ($version ge "1.5.4") {
  34         push @opts, '--cleanup=verbatim';
  35     }
  36     else {
  37         $params{message}.=".";
  38     }
  39
  40 to
  41
  42     $params{message}.="No commit message specified.";
  43
  44
  45 ## Feeds
  46
  47 * The sidebar on the main page displays recent headlines from the DragonFly BSD Digest.
  48 * Pages are saved to /digest/ and displayed using an 'inline' statement.  \[[!inline pages="internal(digest/*)" feeds="no" template="digestitem"]]
  49 * The sidebar on the main page also shows Jenkins results.
  50 * Pages are saved to /ci/ and displayed using an 'inline' statement.  \[[!inline pages="internal(ci/*)" feeds="no" template="digestitem"]]
  51 * The actual feed information is gathered using an aggregate command, kept here so that instructions and actions are in the same place.
  52 * Don't remove the aggregate command from this page unless you have someplace else for it.
  53
  54 Here's the Digest command and output: [[!aggregate  name="DragonFly Digest Feed" dir="digest"
  55 feedurl="http://www.dragonflydigest.com/feed"
  56 url="http://www.dragonflydigest.com/" updateinterval="15"
  57 expireage="14" expirecount="20"]]
  58
  59 Here's the Jenkins command and output: [[!aggregate  name="Jenkins Feed" dir="ci"
  60 feedurl="https://ci.dragonflybsd.org/job/DragonFlyBSD/rssAll"
  61 url="https://ci.dragonflybsd.org/" updateinterval="15"
  62 expireage="30" expirecount="20"]]
  63
  64
  65 ## For more information
  66
  67 * This site contains ikiwiki documentation under /[[ikiwiki]].
  68 * For document editing, visit [[How to edit pages on dragonflybsd.org|docs/howtos/How_To_Edit_This_Site]]