[m-dev.] diff: install web pages

[Fergus Henderson]

On 19-Nov-1998, Peter Ross <petdr at cs.mu.OZ.AU> wrote:
> Place all the install steps for the web site into one file, so that when
> I die the web site will live on.
...
> +++ install_webpages	Thu Nov 19 17:51:49 1998
> @@ -0,0 +1,58 @@
> +#!/bin/sh
> +#
> +# install_webpages
> +#
> +# Responsible for updating the hypermail archive, updating the
> +# search database and installing the web pages.
> +#
> +# Note this script must be run on hydra, have the INSTALL_WEBDIR
> +# environment variable set and be run from the top level directory of
> +# the w3 module.

You should document *why* the script must be run on hydra,
or (better) document what the script requires of the machine
on which it is run, and list hydra as an example of such a machine.

Otherwise, if hydra's death precedes yours, then the web site
may not live on after you ;-)

(The reasons for the other restrictions -- setting INSTALL_WEBDIR
and running from the right directory -- are obvious, so you don't
need to document those.)

-- 
Fergus Henderson <fjh at cs.mu.oz.au>  |  "Binaries may die
WWW: <http://www.cs.mu.oz.au/~fjh>  |   but source code lives forever"
PGP: finger fjh at 128.250.37.3        |     -- leaked Microsoft memo.