Merging the FAQ -> handbook, build time options, proof ofconcept patch

Tom Rhodes trhodes at FreeBSD.org
Fri Dec 3 20:58:34 UTC 2004


On Fri, 3 Dec 2004 13:02:12 -0600 (CST)
Mark Linimon <linimon at lonesome.com> wrote:

> I agree that we don't want any overlap in the FAQ and the handbook,
> or frankly for anyplace else for that matter.  The overlap causes
> confusion for both users and doc committers.  That's one of the
> reasons that the FAQ has rotted so badly.

So, lemmie get this straight.

Quick and question and answers in the faq, more thorough explinations
moved into the handbook?

> 
> I see the FAQ serving as a "Start Here" document for people who
> are not familiar with FreeBSD; as a place for "what is it/why should
> I care/why did you do XYZ" thing.  I see the handbook as "now that
> I have FreeBSD installed, how do I do XYZ".  The timeslice I had to
> do the hackup job was insufficient to have gotten that across.

Yes, I can see your point, valid it is.

> 
> So I don't see having the "include the text here or include the text
> there" knobs as doing anything other than perpetuating the bad
> current practice.
> 
> I'm waving my hands at the "I tried to do XYZ and it didn't work"
> questions which I think are different from the "how do I do XYZ"
> questions.  The latter belong in the handbook, the former I'm not
> so sure of.  Anyone have any experience in setting up a knowledge-
> base app?  I'd accept the argument that that's really where those
> kinds of answers belong.

Here is my problem:  Everyone complains about the FAQ, and what
is wrong with it.  Right now, like this weekend (today if possible),
I want to put that issue to bed.

We need to close this matter and get back to work doing useful
and good things.  So, we have one problem and we need to choose
what to do:

Move most of the FAQ and keep the FAQ simple,
Move all of the FAQ and either have it all in the handbook or as 1 file,
Kill the FAQ off and start it a new.

Those who are actually interested in this discussion have already
voiced thier opinion but we still come up to the same dead lock;
at least in this one case.  What are we going to do, I probably
won't work on the FAQ after it's moved; never have worked on it
to be honest.  So, if you and others are interested in keeping
the FAQ alive but short, then lets move forward.  Tell me the
"big sections" you want to see moved and we'll move them.  You
can then update and work on it all you'd like.  Though, then I
have a problem about the fact we have 2 FAQ-like parts but I
can deal.  Either we do something or not, and I don't think you
and I are really getting each others point.  It's like I follow
you, but at the same time I'm lost on what exactly it is you
want to do.

Thanks!

-- 
Tom Rhodes



More information about the freebsd-doc mailing list