From mboxrd@z Thu Jan 1 00:00:00 1970 From: =?utf-8?Q?Ludovic_Court=C3=A8s?= Subject: Re: WIP Guix Cookbook Date: Wed, 11 Sep 2019 22:02:40 +0200 Message-ID: <87woeer47z.fsf@gnu.org> References: <87pnkb3pil.fsf@elephly.net> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([2001:470:142:3::10]:38809) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1i88pB-0004DS-O3 for guix-devel@gnu.org; Wed, 11 Sep 2019 16:02:47 -0400 In-Reply-To: <87pnkb3pil.fsf@elephly.net> (Ricardo Wurmus's message of "Sun, 08 Sep 2019 15:07:30 +0200") 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: Ricardo Wurmus Cc: guix-devel@gnu.org, GNU Guix maintainers , julien lepiller Howdy! Ricardo Wurmus skribis: > attached is a WIP patch for a Guix Cookbook, a document that is intended > to include articles, tutorials, and annotated examples with links to the > reference manual. The idea is that the reference manual shouldn=E2=80=99= t be > bloated with examples and tutorials, but we=E2=80=99d also like to ensure= high > quality control and a document that can easily be adjusted to match the > changing APIs. That=E2=80=99s a great initiative! Lots of people will surely appreciate i= t. > This initial draft includes parts of Pierre=E2=80=99s packaging tutorial = and > Efraim=E2=80=99s article on customizing the kernel. As I was preparing t= his I > had some doubts about my choices. The kernel article highlights > problems with our API, which makes customizing the kernel somewhat > awkward. The packaging tutorial on the other hand is very large and > includes a Scheme tutorial. Maybe this should be moved to a separate > section=E2=80=A6? I think it=E2=80=99s OK to have it here. Well, it could also be in the Gui= le manual, but that=E2=80=99s fine. Other ideas that come to mind: we could easily expand the section on packaging. Lots of things aren=E2=80=99t quite documented, such as the (gu= ix build utils) tools, or the typical workflows, habits, etc. we=E2=80=99re us= ed to when packaging. We could also turn into text the example from Chris Marusich=E2=80=99s talk about hacking a package: . Another idea: perhaps something based on Chris=E2=80=99 article: . And something based on Jakob=E2=80=99s article: . There=E2=80=99s no shortage of material to reuse. :-) > Efraim=E2=80=99s original article uses the first person as the narrator v= oice, > which is fine for a blog post, but maybe not appropriate for a > collaborative document. Should this be changed? I would say it should be changed and kept consistent throughout, if possible, but it=E2=80=99s no big deal. What should be the next step in your opinion? I think we could have it in =E2=80=98master=E2=80=99 and published on-line quickly: it=E2=80=99s a l= iving document, so there=E2=80=99s really no reason to wait. Thanks for doing this! Ludo=E2=80=99.