From owner-freebsd-ports@freebsd.org Wed Jan 4 12:32:42 2017 Return-Path: Delivered-To: freebsd-ports@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 07AC1C9C887 for ; Wed, 4 Jan 2017 12:32:42 +0000 (UTC) (envelope-from vlad-fbsd@acheronmedia.com) Received: from mail.irealone.com (xoth.irealone.hr [136.243.79.146]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id C420A1518 for ; Wed, 4 Jan 2017 12:32:39 +0000 (UTC) (envelope-from vlad-fbsd@acheronmedia.com) Received: by mail.irealone.com (Postfix, from userid 58) id 37DD97C46; Wed, 4 Jan 2017 13:32:32 +0100 (CET) X-Spam-Checker-Version: SpamAssassin 3.4.1 (2015-04-28) on postfix.xoth.irealone.hr X-Spam-Level: X-Spam-Status: No, score=-100.0 required=5.0 tests=ALL_TRUSTED, LOCAL_TO_FBSD_PORTS autolearn=ham autolearn_force=no version=3.4.1 Received: from mail.irealone.com (unknown [10.0.0.10]) by mail.irealone.com (Postfix) with ESMTP id C4B867C42 for ; Wed, 4 Jan 2017 13:32:31 +0100 (CET) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII; format=flowed Content-Transfer-Encoding: 7bit Date: Wed, 04 Jan 2017 13:32:31 +0100 From: "Vlad K." To: freebsd-ports@freebsd.org Subject: Re: Ports' tips and gotchas Organization: Acheron Media In-Reply-To: References: <76519193d791325700c3beb34b8f447b@acheronmedia.com> Message-ID: X-Sender: vlad-fbsd@acheronmedia.com User-Agent: Roundcube Webmail/1.2.3 X-BeenThere: freebsd-ports@freebsd.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Porting software to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 04 Jan 2017 12:32:42 -0000 On 2017-01-04 10:50, Ben Woods wrote: > > I have often thought that the FreeBSD wiki should contain a space for > ports > help wikis, that can initially be created by the maintainer, but > other's > could also add their tips and tricks. > > It is often said that FreeBSD has great documentation, but only if the > help > you are looking for is in the handbook. For many ports this is not the > case, and projects like ArchLinux have far better documentation for how > to > use their packages. I have started a "proof of concept" section under my namespace, available here: https://wiki.freebsd.org/VladimirKrstulja/PortsTipsTricksAndGotchas It's just a starting layout with a couple of entries about issues mentioned in this thread that got this going. Personally, I'm not sure we should be replicating the width and detail of wikis like ArchLinux'. The primary intent behind this is to offer some crucial and important information that's not immediately obvious to new users, or to list some information that is repeatedly being asked about, otherwise we again risk drowning out important info. So if we really wanted to build a database of information of that magnitude, I believe we should be careful to properly structure and namespace such information so that these important bits are visible first, and the "less important info and/or already available elsewhere" be linked externally or as a sub-page. I primarily want to make a "meta-database" of important information from which all other information is easily accessible. And most importantly: kept up to date. With that I wholeheartedly agree that the maintainers should (per RFC2119 meaning of "should") create a page for ports they maintain and include all the important info there, which can then be expanded by anyone. Just thinking out loud here. -- Vlad K.