From owner-freebsd-doc@FreeBSD.ORG  Wed Apr  3 21:52:28 2013
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: doc@FreeBSD.org
Received: from mx1.freebsd.org (mx1.FreeBSD.org [8.8.178.115])
 by hub.freebsd.org (Postfix) with ESMTP id EE381DDF;
 Wed,  3 Apr 2013 21:52:28 +0000 (UTC)
 (envelope-from wblock@wonkity.com)
Received: from wonkity.com (wonkity.com [67.158.26.137])
 by mx1.freebsd.org (Postfix) with ESMTP id B30C71B8;
 Wed,  3 Apr 2013 21:52:28 +0000 (UTC)
Received: from wonkity.com (localhost [127.0.0.1])
 by wonkity.com (8.14.6/8.14.6) with ESMTP id r33LqRte027024;
 Wed, 3 Apr 2013 15:52:27 -0600 (MDT)
 (envelope-from wblock@wonkity.com)
Received: from localhost (wblock@localhost)
 by wonkity.com (8.14.6/8.14.6/Submit) with ESMTP id r33LqRs0027021;
 Wed, 3 Apr 2013 15:52:27 -0600 (MDT)
 (envelope-from wblock@wonkity.com)
Date: Wed, 3 Apr 2013 15:52:27 -0600 (MDT)
From: Warren Block <wblock@wonkity.com>
To: Garrett Cooper <yaneurabeya@gmail.com>
Subject: Re: Need help documenting development processes in FreeBSD
In-Reply-To: <CAGHfRMCUKCCbVYhfeEDY_NJLqkEe2C=b9wbFs8RG-n+H04wDfA@mail.gmail.com>
Message-ID: <alpine.BSF.2.00.1304031550030.26934@wonkity.com>
References: <CAGHfRMCUKCCbVYhfeEDY_NJLqkEe2C=b9wbFs8RG-n+H04wDfA@mail.gmail.com>
User-Agent: Alpine 2.00 (BSF 1167 2008-08-23)
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; format=flowed; charset=US-ASCII
X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.4.3
 (wonkity.com [127.0.0.1]); Wed, 03 Apr 2013 15:52:27 -0600 (MDT)
Cc: core@FreeBSD.org, doc@FreeBSD.org
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.14
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/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: Wed, 03 Apr 2013 21:52:29 -0000

On Mon, 1 Apr 2013, Garrett Cooper wrote:

>    In order to bring contributors up to speed on how to interact with
> FreeBSD, I want to document some of the items that aren't really noted in
> the FreeBSD developers or committers handbook. Some topics that come to
> mind are "How do I do a precommit build?" (tinderbox, etc), "How do I test
> my changes?" (there's a chapter, but it's not helpful), "How do I get
> involved with the project?", "How do I build quickly?", "What are mtree
> files?", etc.
>    I was wondering if a) there are any other developers interested in this
> effort, b) where it should go (in the dev handbook?), and c) who would be
> interested in reviewing the work? I'd like to put it up on the wiki first
> (as I'm not an SGML wizard) and put it in SGML eventually, but I need
> feedback on whether or not this is doable.

This is interesting to me.  I'd suggest an outline first, and not 
worrrying about markup until a rough framework is done.  I can help with 
markup and review.