From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms8.migadu.com with LMTPS id 2LNzFJTVTmVrVQEAG6o9tA:P1 (envelope-from ) for ; Sat, 11 Nov 2023 02:15:00 +0100 Received: from aspmx1.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id 2LNzFJTVTmVrVQEAG6o9tA (envelope-from ) for ; Sat, 11 Nov 2023 02:15:00 +0100 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 34E163D1BA for ; Sat, 11 Nov 2023 02:15:00 +0100 (CET) Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=excalamus.com header.s=zmail header.b=T4tG3gik; dmarc=none; arc=pass ("zohomail.com:s=zohoarc:i=1"); spf=pass (aspmx1.migadu.com: domain of "guix-devel-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-devel-bounces+larch=yhetil.org@gnu.org" ARC-Seal: i=2; s=key1; d=yhetil.org; t=1699665300; a=rsa-sha256; cv=pass; b=O/Th/j00u+IMmeiL9IJuXmHWCXIA9hRia+FPfWuqAzgLPruqYlA8uhVspsfFShBB/spEBu LYz1FKYr58DhrItbiKYCjGn6wucV7v82/ihVVx6VkxYsgjTnCr7jGQoJ0qDlABBXGt9SAp WeL07G6RA5N4jq+H2D7VtZewd6mOht1jNNjNc34jiV0b/8IkHS/k9gdXdvNofpdKHbCrwM BxiKOZsSK3rGiFSR3R4aTjqCVi31rEWSFRGkbqfdV1wzqIdQ5zu1mv8sxMCBZhFYsKxph9 zy9PQUsIU+ZBxOzOHgLbEQkm8+Xkgp07/Mni6iR44SkYXAUfJGKD0X38Ye8CRg== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1699665300; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=mNkY36supwplpickOLSVXeUrceluHTzKzuucHGHUrlc=; b=ESyw6BrrMdhSGo7EQX7oT6SMtWKI9pjFjI/1elnlOpavQGcSd2k2IbSCoIS+uIoA+mx1vM YHNe+ECNlhAlSBvMjRmEw7nxlPctJXlNmdL7wz1VKYGwSzM1EqJxJt5PfI7R1uWlZ0YtkA CKY2FlbQJABeh17ab8RDySf+DGP1y66Fn+gN0wdJTxk9j6uARbUUG9HHCLysbqdP1SMB/f yIZ9cyuO+Q2+M7Es++qeb2T5U0dy5HBG2zKrwSxUsWdimWXH23PN37pxZLwUwy36aC+f3R gZ7qEgLyNQ0EvrxycXTx8mGT2RIeeHH+DVODMMZe8r+qlZCwRyLbFj3PV05uKA== ARC-Authentication-Results: i=2; aspmx1.migadu.com; dkim=pass header.d=excalamus.com header.s=zmail header.b=T4tG3gik; dmarc=none; arc=pass ("zohomail.com:s=zohoarc:i=1"); spf=pass (aspmx1.migadu.com: domain of "guix-devel-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-devel-bounces+larch=yhetil.org@gnu.org" Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1r1cZq-0007eZ-Op; Fri, 10 Nov 2023 20:14:22 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r1cZp-0007e4-3E for guix-devel@gnu.org; Fri, 10 Nov 2023 20:14:21 -0500 Received: from sender4-op-o15.zoho.com ([136.143.188.15]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r1cZn-0005Cm-5h for guix-devel@gnu.org; Fri, 10 Nov 2023 20:14:20 -0500 ARC-Seal: i=1; a=rsa-sha256; t=1699665255; cv=none; d=zohomail.com; s=zohoarc; b=cWUDOTllydQCy1C4hGnA+drGdxEZQiv7zs1YZOWX/AeC+rfftyWgFf2YA2F8rxEOQZHAzuXOCYcFkYcPsjrZkapkIug5DsqKI5homBpFSFIw/AQJc4L+k4IbjDQ/aWP+SlvuK5A1rZVMh7o5oSaUGsEVirpwiRyFhKWAn7wYtt4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1699665255; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:Subject:To:To:Message-Id:Reply-To; bh=mNkY36supwplpickOLSVXeUrceluHTzKzuucHGHUrlc=; b=hNUbrjhOecChfzs6vedEn5ClIMtWPYg0XJVMwTvfHAbrJ3c28c1LLPwaigH8+kOU7evy2WXUQI+4uh38YFZxPjffiZsyjWV3mPE2SUCCTMOn+Ijf1KU/I60kKOiTEfaTWbKO1+TK5TghJajTXf3pOa4JZ2L27ySbemPiYGnr6K4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=excalamus.com; spf=pass smtp.mailfrom=matt@excalamus.com; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1699665255; s=zmail; d=excalamus.com; i=matt@excalamus.com; h=Date:Date:From:From:To:To:Cc:Cc:Message-ID:In-Reply-To:References:Subject:Subject:MIME-Version:Content-Type:Content-Transfer-Encoding:Message-Id:Reply-To; bh=mNkY36supwplpickOLSVXeUrceluHTzKzuucHGHUrlc=; b=T4tG3gikbISrrCpdToMycbymnE5QkJmXMl8dmV18s2p+CznPjviz53ndjb13qLAj sJ+zewmECmHt+QUbf9qp1lE2cOgjnipL6etgdoDZrqfwQ4mbrejFuhRz4yDuEqeEDKI JKfIUTAX1ep8pO/Ke1CzaoG9Z4AgHBIahIKkAkf4= Received: from mail.zoho.com by mx.zohomail.com with SMTP id 1699665253945712.6735147303413; Fri, 10 Nov 2023 17:14:13 -0800 (PST) Date: Sat, 11 Nov 2023 02:14:13 +0100 From: Matt To: "Samuel Christie" Cc: "guix-devel" Message-ID: <18bbbf1961e.e98629bb1536571.1451071591878652133@excalamus.com> In-Reply-To: <878r7aa4g4.fsf@sdf.org> References: <87msyhgccg.fsf@disroot.org> <547c097a-d805-9a55-11d9-b0434327f89d@gmail.com> <871qfpjhiz.fsf@gmail.com> <87a5udaq7q.fsf@envs.net> <87il8z9yw8.fsf@xelera.eu> <7364531e-5816-799d-5c71-621892082e48@fannys.me> <87h6niffpl.fsf_-_@sdf.org> <18b3a24114f.e66ea6b1235588.3958425111160808928@excalamus.com> <878r7aa4g4.fsf@sdf.org> Subject: Re: Enabling contribution through documentation MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 7bit Importance: Medium User-Agent: Zoho Mail X-Mailer: Zoho Mail Received-SPF: pass client-ip=136.143.188.15; envelope-from=matt@excalamus.com; helo=sender4-op-o15.zoho.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: guix-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list 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+larch=yhetil.org@gnu.org Sender: guix-devel-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Scanner: mx11.migadu.com X-Spam-Score: -10.13 X-Migadu-Queue-Id: 34E163D1BA X-Migadu-Spam-Score: -10.13 X-TUID: /+0TGJQNTJ5V ---- On Mon, 06 Nov 2023 23:43:07 +0100 Samuel Christie wrote --- > > Hello Matt; sorry, I've been distracted and almost missed your reply a few weeks ago. Not a problem! I've been distracted, too. :) > Any thoughts on process? Maybe we could have a repo managed the same way Guix is, so I can learn that at the same time. (That is, emails for discussion and patches to the tutorial) How hard would that be to get or set up? A central repo makes sense. I'm open to exchanging patches over email rather than doing PRs. If it's okay with the Guix mailing list, I would be happy to have that exchange here so that others may observe, comment, and contribute. I've set up a repo here: https://codeberg.org/excalamus/guix-packaging-tutorial/src/branch/master/guix-packaging-tutorial.org > After that, I think the first step is picking an easy but non-trivial package to do. Maybe it should be one that's already been packaged... I went through a list of packages that I wished Guix had, and sadly none of them were easy enough for me to do. My first choice was INN (a Usenet server), but it has multiple service dependencies I wasn't sure how to handle. My other choices were apparently in Rust, which always has waaay too many deps. We could also do a better Hello tutorial. Thoughts? I think we should do a more detailed Hello tutorial. It is already referenced in the cookbook, it's non-trivial, and this is the use case it was created for. The package definition already exists (gnu/packages/base.scm). Some words on the document: I'd like to see the finished tutorial included in the cookbook. For that, it needs to be written in Texinfo. It's currently in Org. That's simply what I'm most familiar with and the format my notes were in. Org exports to Texinfo and info. While I'm sure the conversion is imprecise, sticking with Org allows me (at least) to write more easily. It's familiar and generates an (approximate) info file. My intent is to focus on explaining the topic and worry about the details of Texinfo later. Otherwise, Org provides a practical benefit: it embeds "live" source blocks. We can run all our shell calls from the document. My hope is that this will keep the source code and shell call snippets accurate. For anyone unfamiliar with Org, I've heavily annotated the document with explanations about how to navigate, edit, and transform it to other formats. If that's too much, that's okay. Just edit the text and we can take care of any markup syntax later. I'm excited to work on this with you and anyone else. I'm curious what your thoughts are :)