From owner-freebsd-doc@FreeBSD.ORG Thu Feb 13 20:25:00 2014 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id BC5C793; Thu, 13 Feb 2014 20:25:00 +0000 (UTC) Received: from bigwig.baldwin.cx (bigwig.baldwin.cx [IPv6:2001:470:1f11:75::1]) (using TLSv1 with cipher ADH-CAMELLIA256-SHA (256/256 bits)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id 92A541E5B; Thu, 13 Feb 2014 20:25:00 +0000 (UTC) Received: from ralph.baldwin.cx (pool-173-70-85-31.nwrknj.fios.verizon.net [173.70.85.31]) by bigwig.baldwin.cx (Postfix) with ESMTPSA id 847F2B9CA; Thu, 13 Feb 2014 15:24:59 -0500 (EST) From: John Baldwin To: freebsd-doc@freebsd.org Subject: Re: [PATCH] Use a bullet list for general policies Date: Sat, 08 Feb 2014 16:25:25 -0500 Message-ID: <2667682.EQsnSbIC49@ralph.baldwin.cx> User-Agent: KMail/4.10.5 (FreeBSD/10.0-STABLE; KDE/4.10.5; amd64; ; ) In-Reply-To: <52F63858.3010202@FreeBSD.org> References: <201401311421.31347.jhb@freebsd.org> <52F63858.3010202@FreeBSD.org> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" X-Greylist: Sender succeeded SMTP AUTH, not delayed by milter-greylist-4.2.7 (bigwig.baldwin.cx); Thu, 13 Feb 2014 15:24:59 -0500 (EST) X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.17 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 13 Feb 2014 20:25:00 -0000 On Saturday, February 08, 2014 02:59:52 PM Benedict Reuschling wrote: > Am 31.01.14 20:21, schrieb John Baldwin: > > Right now the internal policies page has a paragraph that lists the > > project's policies inline in one big sentence. I find this harder > > to work with as if I'm looking for a particular policy I have to > > scan the entire sentence. I think in this case a bulleted list > > works better. The patch below changes it (note that I haven't > > reordered them, and it may be that there is a better order, though > > I'm not sure what it would be). Any objections? > > > > Index: head/en_US.ISO8859-1/htdocs/internal/policies.xml > > =================================================================== > > --- head/en_US.ISO8859-1/htdocs/internal/policies.xml (revision 43698) > > > +++ head/en_US.ISO8859-1/htdocs/internal/policies.xml (working > > copy) @@ -34,25 +34,18 @@ > > > >

General Policies

> > > > -

Here you will find various things such as the - > href="new-account.html">New Account Creation Procedure, -the > > -Commit Bit Expiration Policy, -the > > -Core Bylaws, -the - > href="resources.html">Commit Bit and Project Resources Policy, > > -Core's Voting Procedures, -the - > href="fortunes.html">Fortune File Policy, -the - > href="i18n.html">Internationalization Policy, -the - > href="data.html">User Data Policy, -the - > href="hats.html">Hats Term Limits Policy, -and the - > href="../doc/en_US.ISO8859-1/articles/pr-guidelines/">Problem > > Report Handling Guidelines.

+ > > > >

The FreeBSD Documentation Project

> > Hmm, maybe we should group "Commit Bit Expiration Policy" and "Commit > Bit and Project Resources Policy" together as well as the "Core > Bylaws" with "Core's Voting Procedures" as they are related topics. > The rest is pretty much standalone and I can't find any other better > order. I can also live with Eitan's suggestion of having them in > alphabetical order. I did think about grouping them some, but I found that the categories I was going to use (governance, inter-developer relationships) did not lend themselves to clear separation as many of the individual items fit into multiple categories, etc. Also, this page is a bit of a dumping ground as it is. I do think it might make sense to have a page that looks a bit more like: - Project Bylaws (rename the core bylaws to this) - Team Charters - portsmgr charter - secteam charter - re charter (does this exist?) - clusteradm charter - Policies - Right now I think some of the charters are scattered into different pages which isn't but so helpful for someone who wants to get a sense of how the Project works and/or is organized. -- John Baldwin