My wish list for 6.1

[Ceri Davies]

On Mon, Dec 19, 2005 at 10:34:23AM +0100, Dirk GOUDERS wrote:
> 
> > 3.  Full review and update of the install docs, handbook, FAQ, etc. 
> > 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.
> 
> 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.
> 
> 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.
> 
> 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 at .

Ceri
-- 
Only two things are infinite, the universe and human stupidity, and I'm
not sure about the former.			  -- Einstein (attrib.)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
Url : http://lists.freebsd.org/pipermail/freebsd-hackers/attachments/20051220/1719ae90/attachment.bin