From owner-freebsd-doc@FreeBSD.ORG  Mon Dec  6 17:48:36 2004
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP
	id 2F28B16A4CE; Mon,  6 Dec 2004 17:48:36 +0000 (GMT)
Received: from rwcrmhc12.comcast.net (rwcrmhc12.comcast.net [216.148.227.85])
	by mx1.FreeBSD.org (Postfix) with ESMTP
	id E8FEF43D3F; Mon,  6 Dec 2004 17:48:35 +0000 (GMT)
	(envelope-from zettel@acm.org)
Received: from [192.168.0.2]
	(bgp966574bgs.derbrn01.mi.comcast.net[68.41.108.205])
	by comcast.net (rwcrmhc12) with ESMTP
	id <2004120617483501400en7vde>; Mon, 6 Dec 2004 17:48:35 +0000
From: Len Zettel <zettel@acm.org>
To: Murray Stokely <murray@freebsdmall.com>
Date: Mon, 6 Dec 2004 12:48:16 +0000
User-Agent: KMail/1.6.2
References: <20041128202656.GL750@zaphod.nitro.dk>
	<200412031329.34102.zettel@acm.org> <20041206171630.GJ78078@freebsdmall.com>
In-Reply-To: <20041206171630.GJ78078@freebsdmall.com>
MIME-Version: 1.0
Content-Disposition: inline
Content-Type: text/plain;
  charset="iso-8859-1"
Content-Transfer-Encoding: 7bit
Message-Id: <200412061248.16595.zettel@acm.org>
cc: Tom Rhodes <trhodes@freebsd.org>
cc: freebsd-doc@freebsd.org
cc: Nik Clayton <nik@freebsd.org>
cc: "Simon L. Nielsen" <simon@freebsd.org>
Subject: Re: Doc BoF at EuroBSDCon
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 06 Dec 2004 17:48:36 -0000

On Monday 06 December 2004 05:16 pm, Murray Stokely wrote:
> On Fri, Dec 03, 2004 at 01:29:34PM +0000, Len Zettel wrote:
> > This could change if three things moved up the
> > priority list.
> > 1) Fixing the doc infrastructure so it worked as
> > advertised.
> >
> > 2) Updating the advertising so a newbie could
> > find out how it worked without a lot of thrashing around.
>
> Hi Len, the Doc Project Primer is still the place to go for learning
> about how it all works.
>
> http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/index.html
>
> Please open a PR if you think this document is misleading you in any
> way.  It seems to be up to date to me.
>
> - Murray
I have tried to read the doc primer (long about September-October 
2004).

At the moment, my problem is this. Not too long ago, I thought
I saw where some improvements could be made to the documentation.
I also figured that the the more work I could do to setting the
proposed changes up to go automagically the better the
chances were of their actually getting introduced smoothly
and promptly.

So I took a stab at creating an sgml file incorporating the changes
(by editing the existing file for the document in question).
When it came time create an html file from the sgml (so I
could check the work) I flunked out.  The make couldn't
find some of the necessary boiler plate. 

So I took a chance, created a diff using the edited file
and dashed off a PR.

Part of my ever-expanding "todo" list is to take another
stab at going from sgml to html.  When I am happy 
with that I will take another crack at a PR or two.
That likely won't be for a while yet.
  -LenZ-