Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 20 Dec 2005 14:22:54 +0000
From:      Ceri Davies <ceri@submonkey.net>
To:        Dirk GOUDERS <gouders@et.bocholt.fh-ge.de>
Cc:        Scott Long <scottl@samsco.org>, hackers@freebsd.org
Subject:   Re: My wish list for 6.1
Message-ID:  <20051220142254.GD68989@submonkey.net>
In-Reply-To: <200512190934.jBJ9YNhX022376@musashi.et.bocholt.fh-gelsenkirchen.de>
References:  <43A26FFB.9080405@samsco.org> <200512190934.jBJ9YNhX022376@musashi.et.bocholt.fh-gelsenkirchen.de>

next in thread | previous in thread | raw e-mail | index | archive | help

--rQ2U398070+RC21q
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Mon, Dec 19, 2005 at 10:34:23AM +0100, Dirk GOUDERS wrote:
>=20
> > 3.  Full review and update of the install docs, handbook, FAQ, etc.=20
> > There are sections that are embarrassingly out of date (one section of
> > the handbook apparently states that we only support a single brand of
> > wifi cards).  A co-worker of mine tried to install 6.0 using just the
> > handbook install guide, and discovered that it really doesn't match
> > reality anymore, in both big and small ways.  Contact me directly if
> > you would like his list of comments.
>=20
> I am wondering if it wouldn't be advantageous to have "versioned"
> documents that just cover one specific release and not to cover all
> realeases in single documents.
>=20
> I could imagine that it is harder to cover everything in single
> documents than to perhaps copy the existing documentation when a new
> branch is created and edit it to match just the new release.
>=20
> Maybe, I do not realize how much more work this would be but it would
> probably enforce regular reviews of the documentation and the readers
> would benefit from it.

This is exactly the idea that I have been pimping to anyone who will
listen for the last three months or so.  I also think that it is
advantageous for users who are using, say 4.2, to be able to find
documentation for 4.2 without having to interpret a nest of "if you have
4.x do this, if 5.0 through 5.3 do that, else do the other".  I don't
think it's a lot of work to just branch the handbook (and FAQ
if we decide to keep it) - in fact, for me, it would be a definite win -
at release time, but it just doesn't seem to be what other people want
done.

I would encourage those interested to ask about it on doc@.

Ceri
--=20
Only two things are infinite, the universe and human stupidity, and I'm
not sure about the former.			  -- Einstein (attrib.)

--rQ2U398070+RC21q
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2 (FreeBSD)

iD8DBQFDqBO+ocfcwTS3JF8RAqJTAJ9pkMbrH21XQNpdjsjeLM15qEou5gCgrGAn
J3pV44VzXdtsYi3NbQqhSg4=
=0p6l
-----END PGP SIGNATURE-----

--rQ2U398070+RC21q--



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20051220142254.GD68989>