From owner-freebsd-ports@FreeBSD.ORG Sat Jul 5 02:35:28 2014 Return-Path: Delivered-To: freebsd-ports@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 A5D56D0 for ; Sat, 5 Jul 2014 02:35:28 +0000 (UTC) Received: from wonkity.com (wonkity.com [67.158.26.137]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "wonkity.com", Issuer "wonkity.com" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 531A12AA2 for ; Sat, 5 Jul 2014 02:35:27 +0000 (UTC) Received: from wonkity.com (localhost [127.0.0.1]) by wonkity.com (8.14.9/8.14.9) with ESMTP id s652ZKSl034052 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO); Fri, 4 Jul 2014 20:35:20 -0600 (MDT) (envelope-from wblock@wonkity.com) Received: from localhost (wblock@localhost) by wonkity.com (8.14.9/8.14.9/Submit) with ESMTP id s652ZK6Z034049; Fri, 4 Jul 2014 20:35:20 -0600 (MDT) (envelope-from wblock@wonkity.com) Date: Fri, 4 Jul 2014 20:35:20 -0600 (MDT) From: Warren Block To: Mike Brown Subject: Re: Some suggestions about PKGNG documentation In-Reply-To: <201407050100.s651010v007738@chilled.skew.org> Message-ID: References: <201407050100.s651010v007738@chilled.skew.org> User-Agent: Alpine 2.11 (BSF 23 2013-08-11) MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII; format=flowed X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.4.3 (wonkity.com [127.0.0.1]); Fri, 04 Jul 2014 20:35:20 -0600 (MDT) Cc: freebsd-ports@freebsd.org X-BeenThere: freebsd-ports@freebsd.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Porting software to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 05 Jul 2014 02:35:28 -0000 On Fri, 4 Jul 2014, Mike Brown wrote: > Patrick Powell wrote: >> TUTORIAL: The Savant's Guide To Ports, Packages, PkgNG >> Try to put a lot of the information about pkgng, repositories, >> etc. in a single place. I suggest a tutorial format, rather >> than a user manual format, with references to the various >> man pages, other documents, etc. > > Your suggestions sound good to me. > > Unfortunately, it's not like there's a team of tech writers sitting around > waiting for suggestions of things to write and put into the docs. Rather, > updating pretty much anything in the documentation -- or the ports for that > matter -- requires "suggesting" the actual changes you want in the form of > patches that replace the existing content with your version. The documentation team has a standing offer to either assist with markup or accept content-only submissions and do the markup on them. Clear, useful instructions are the difficult part to create. It helps if the writer is familiar with existing work like the Handbook, but is not required. > After starting down this road, you may decide it's less of an ordeal just to > write something yourself and put it up on your own blog. :/ It's sometimes easier to do that, but fewer people benefit.