From owner-freebsd-doc@FreeBSD.ORG Sun Nov 28 20:27:01 2004 Return-Path: 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 AACF316A4CE for ; Sun, 28 Nov 2004 20:27:01 +0000 (GMT) Received: from zaphod.nitro.dk (port324.ds1-khk.adsl.cybercity.dk [212.242.113.79]) by mx1.FreeBSD.org (Postfix) with ESMTP id 43B6D43D1D for ; Sun, 28 Nov 2004 20:26:59 +0000 (GMT) (envelope-from simon@zaphod.nitro.dk) Received: by zaphod.nitro.dk (Postfix, from userid 3000) id 65F8A11C14; Sun, 28 Nov 2004 21:26:57 +0100 (CET) Date: Sun, 28 Nov 2004 21:26:57 +0100 From: "Simon L. Nielsen" To: freebsd-doc@freebsd.org Message-ID: <20041128202656.GL750@zaphod.nitro.dk> Mime-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="DesjdUuHQDwS2t4N" Content-Disposition: inline User-Agent: Mutt/1.5.6i Subject: Doc BoF at EuroBSDCon X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 28 Nov 2004 20:27:01 -0000 --DesjdUuHQDwS2t4N Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Hello doc people At EuroBSDCon we held a little Bird-Of-Feather (BOF) were we talked a bit about ideas for future doc work. Below is a summary of what we talked about. If anything is unclear, please don't hesitate to ask, and I (or hopefully some other BOF attendee) will try to elaborate. This will certainly not something that will happen overnight, and I do expect that there are other people who have comments. EuroBSDCon was a while ago, I just haven't gotten around to actually posting it in public, sorry about that. Personal note: While I still very much think the issues we talked about are important, and are the way to go, I have a few other large FreeBSD related projects that is taking up a lot of my time, so it will be a bit before I have the time to seriously work on the topics presented below... --------------------------------------------------------------------- FreeBSD "Spontaneous" Doc BOF, Saturday evening 2004/10/30 Attending: brueffer, ceri, des, mheinen, ru, simon, trhodes. Note: A more formal doc BOF was scheduled earlier Saturday, but it was announced to late, so not enough people showed up, so it was postponed. The second BOF just happened since we realized that we were at lot of doc people gathered. Discussed: - Changing doc from SGML to XML (yes, really do it this time) - des agreed to make a script for the actual conversion of the files from SGML to XML. - With SGML -> XML conversion we will loose the "IGNORE" functionality from SGML, but it is not widely used, and where such functionality is needed it can e.g. be handled in other ways. This is used to be able to build sub directories in the Handbook, but this has been broken for a while and nobody has complained about that yet... - It was suggested to move chapter files to the main directory e.g. en_US.ISO8859-1/books/handbook/x11/chapter.sgml -> en_US.ISO8859-1/books/handbook/x11.sgml, since there does not seem to a big point in all the sub directories, and make does not like the sub directories well.. - Redoing the build system (make files), because it clearly shows its age and several things are broken, e.g. OBJDIR. - To be as little disruptive as possible to normal doc work it was suggested to branch the doc/ tree for the work, and do the work in a separate branch, to be merged into the main branch later again. - Handling multiple FreeBSD release branches (4.X/5.X/6.X) in Handbook to get rid of notes about "For 4.X do....". There should be multiple build Handbook versions on website, and perhaps one complete one with "This section is for 4.X only..." and so on automatically added. - It was suggested to handle this with (SG|X)ML attributes on like done in the release documentation for different architectures. simon was volunteered to implement this. --------------------------------------------------------------------- --=20 Simon L. Nielsen --DesjdUuHQDwS2t4N Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.6 (FreeBSD) iD8DBQFBqjSQh9pcDSc1mlERApnSAJ9J3bdEl/VOmwXf9AH/QmMDw0yQNgCcCKEK T6BG7wxkfSBlwUcLK8t7w0s= =SJtN -----END PGP SIGNATURE----- --DesjdUuHQDwS2t4N--