X-Git-Url: https://gitweb.dragonflybsd.org/ikiwiki.git/blobdiff_plain/16a470085de4e6f60f1d76d1545181950824ea3b..HEAD:/docs/howtos/HowToManageThisSite.mdwn

diff --git a/docs/howtos/HowToManageThisSite.mdwn b/docs/howtos/HowToManageThisSite.mdwn
index 673d62cd..5f521c36 100644
--- a/docs/howtos/HowToManageThisSite.mdwn
+++ b/docs/howtos/HowToManageThisSite.mdwn
@@ -2,34 +2,65 @@ This site is managed using ikiwiki.
 
 ## File locations
 
-* `/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. (commit here)
-* `/usr/local/www/www.dragonflybsd.org/` Static output from ikiwiki.
+* `/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)
+* `/usr/local/www/ikiwiki-srcdir/` : The checked out work for site generation.  Ikiwiki uses this; shouldn't need to be touched. 
+* `/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.
 * 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/local/etc/ikiwiki-templates/` - page.tmpl is probably the one you want.  These are just the overrides from /usr/pkg/share/ikiwiki/templates.
-* Stylesheet changes are in `/usr/pkg/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`.
 
+## Making changes
+
+* Edit pages directly.
+* 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 go in `/usr/local/share/ikiwiki/basewiki/local.css`.
+* Add images by committing them to the repo.
+* After modifying any of the templates or stylesheet info, regenerate the site with `ikiwiki --setup /usr/local/etc/ikiwiki.setup`.
 
 ## Upgrading
 
-* Back up `/usr/local/www/ikiwiki-srcdir/`, `/usr/local/www/ikiwiki-repo.git/`, `/usr/pkg/share/ikiwiki/templates/`, and `/usr/local/etc/ikiwiki.setup`, just to be safe.
-* Save `/usr/pkg/share/ikiwiki/basewiki/favicon.ico` and `/usr/pkg/share/ikiwiki/basewiki/local.css` separately.  These will need to be restored after upgrade, as they're modified from what comes with the ikiwiki package.
-* Upgrade.  Delete/rebuild or pkg_rolling-replace or whatever.
+* 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.  Hint: use /root/adm/ikiwiki-backup.
+* 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.  
+* Pages are saved to /digest/ and displayed using an 'inline' statement.  \[[!inline pages="internal(digest/*)" feeds="no" template="digestitem"]]
+* The sidebar on the main page also shows Jenkins results.  
+* Pages are saved to /ci/ and displayed using an 'inline' statement.  \[[!inline pages="internal(ci/*)" 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="1"
-expireage="7" expirecount="20"]]
+
+Here's the Digest command and output: [[!aggregate  name="DragonFly Digest Feed" dir="digest"
+feedurl="https://www.dragonflydigest.com/category/dragonfly/feed/"
+url="http://www.dragonflydigest.com/" updateinterval="15"
+expireage="28" expirecount="7"]]
+
+Here's the Jenkins command and output: [[!aggregate  name="Jenkins Feed" dir="ci"
+feedurl="https://ci.dragonflybsd.org/job/DragonFlyBSD/rssAll"
+url="https://ci.dragonflybsd.org/" updateinterval="15"
+expireage="30" expirecount="20"]]
+
 
 ## For more information