From mboxrd@z Thu Jan 1 00:00:00 1970 From: Leo Famulari Subject: Re: feedback as solicited by Guix manual (Section 7.1.5) Date: Tue, 31 May 2016 13:56:59 -0400 Message-ID: <20160531175659.GA17589@jasmine> References: <574B8D1E.6080000@ethan-stefan.net> <20160531155854.GA27525@jasmine> <87oa7mxk8b.fsf@mailerver.i-did-not-set--mail-host-address--so-tickle-me> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:60729) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1b7nvu-0001ys-Qk for guix-devel@gnu.org; Tue, 31 May 2016 13:58:27 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1b7nvq-0007pJ-OH for guix-devel@gnu.org; Tue, 31 May 2016 13:58:25 -0400 Received: from out2-smtp.messagingengine.com ([66.111.4.26]:39040) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1b7nvo-0007nh-EM for guix-devel@gnu.org; Tue, 31 May 2016 13:58:22 -0400 Content-Disposition: inline In-Reply-To: <87oa7mxk8b.fsf@mailerver.i-did-not-set--mail-host-address--so-tickle-me> List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org Sender: "Guix-devel" To: Matthew Jordan Cc: guix-devel@gnu.org On Tue, May 31, 2016 at 12:31:16PM -0400, Matthew Jordan wrote: > What follows are the steps I took to setup my GuixSD box. What I'm > wondering is how would I go about contributing this in some way to the > documentation? With some modification of course. What parts do you think should be added to our manual? A number of these steps are already covered in section 7.1 System Installation. > I am just presenting this cause I had to look around a lot, such as the > Gentoo Installation Manual, and Arch Linux manuals in addition to the > Parted and Guix Manuals when I attempted my first install. Just thought > it would be a good idea to perhaps have some solid example/steps in the > Guix Manual for the installation. Personally, I don't like putting instructions on how to use 3rd party software in manuals such as ours (or the Gentoo or Arch manuals) unless the information is very specific to how we use the software. In my opinion, if there is some deficiency with the 3rd party programs' documentation, that documentation should be improved. Otherwise, knowledge is fragmented into a variety of places where it probably won't be updated as the 3rd party software changes. Also, each system's manual or wiki will invariably contain some info that is specific to that system but not declared as such. And the new, external documentation will probably not be reviewed by the upstream maintainers for correctness, spreading bad advice across the internet. Finally, the upstream manual will *still* not be improved. On the other hand, we should strive to make our system as easy to install as possible. So, specific advice is most welcome! :)