Formatting for clarity
[ikiwiki.git] / 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)
6 * `/usr/local/www/ikiwiki-srcdir/` : The checked out work for site generation. (commit here)
7 * `/usr/local/www/www.dragonflybsd.org/` Static output from ikiwiki.
8 * Source is publically browsable at [gitweb.dragonflybsd.org](http://gitweb.dragonflybsd.org/).
9 * Configuration file is at `/usr/local/etc/ikiwiki.setup`.
10 * 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.  This affects all pages; the sidebar menu is here.
11 * Stylesheet changes are in `/usr/pkg/share/ikiwiki/basewiki/local.css`.
12 * After modifying any of the templates or stylesheet info, regenerate the site with `ikiwiki --setup /usr/local/etc/ikiwiki.setup`.
13 * The bugs.dragonflybsd.org website needs to be updated separately to make the sidebar match; `/home/bugtracker/html/page.html` is the file to edit.
14
15
16 ## Upgrading
17
18 * 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.
19 * 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.
20 * Upgrade.  Delete/rebuild or pkg_rolling-replace or whatever.
21 * Run any ikiwiki transition commands mentioned in the release notes at http://ikiwiki.info/news/ .
22 * Check for any new plugins that could be enabled; place them in the ikiwiki.setup file.
23
24 ## Feeds
25
26 * The sidebar on the main page displays recent headlines from the DragonFly BSD Digest.  
27 * Pages are saved to /digest/ and displayed using an 'inline' statement.  \[[!inline pages="internal(digest/*)" feeds="no" template="digestitem"]]
28 * The actual feed information is gathered using an aggregate command, kept here so that instructions and actions are in the same place.
29 * Don't remove the aggregate command from this page unless you have someplace else for it.
30 * Here's the command and output: [[!aggregate  name="DragonFly Digest Feed" dir="digest"
31 feedurl="http://www.shiningsilence.com/dbsdlog/feed"
32 url="http://www.shiningsilence.com/dbsdlog/" updateinterval="1"
33 expireage="7" expirecount="20"]]
34
35 ## For more information
36
37 * This site contains ikiwiki documentation under /[[ikiwiki]].
38 * For document editing, visit [[How to edit pages on dragonflybsd.org|docs/howtos/How_To_Edit_This_Site]]