[Koha-devel] Documentation expectations

[Mark Tompsett]

Greetings,

Let’s splice this comment off from Tomas:
> BTW, I have to insist that IMHO all the install-related documentation
> should refer to the stable branches and avoid confusing the users.
> So, until we make a decision on this we should not make references
> to things we do for the current master.

We have packages, tarball, git, and wiki.

I think INSTALL.{OS} should refer to the branch/tgz for which it is in.
If you download a 3.12.x tarball, you aren’t expecting to get 3.14.x or master instructions. You are expecting 3.12.x instructions.
If you branch to v3.10.x in git, you aren’t expecting to get master instructions either, but rather 3.10.x instructions.
If you do a package installation, you probably are looking at the wiki, and are likely expecting instructions matching the current stable version.

This, by the way, led me to try to find installation instructions for packages:
    cd /usr/share/docs/koha-common/
    zcat ... | less
Where ... is one of the release notes points to:
http://wiki.koha-community.org/wiki/Installation_Documentation
This was a little on the ugly side. I cleaned it up a bit.

It also points to the INSTALL.{OS} file in the tarball.

Anyways, I think that covers all the cases. Comments?

GPML,
Mark Tompsett
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.koha-community.org/pipermail/koha-devel/attachments/20131105/43aecd1c/attachment.html>