From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id UIyPAiwn62G5ewAAgWs5BA (envelope-from ) for ; Fri, 21 Jan 2022 22:35:40 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id sJjzNisn62FKEgAAG6o9tA (envelope-from ) for ; Fri, 21 Jan 2022 22:35:39 +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 8745C10459 for ; Fri, 21 Jan 2022 22:35:39 +0100 (CET) Received: from localhost ([::1]:42836 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nB1ZK-0000RZ-HQ for larch@yhetil.org; Fri, 21 Jan 2022 16:35:38 -0500 Received: from eggs.gnu.org ([209.51.188.92]:36592) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nB17e-0006Dx-M6 for guix-patches@gnu.org; Fri, 21 Jan 2022 16:07:02 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:42273) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nB17e-0002ih-9f for guix-patches@gnu.org; Fri, 21 Jan 2022 16:07:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nB17e-0002DJ-53 for guix-patches@gnu.org; Fri, 21 Jan 2022 16:07:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#53287] [PATCH] doc: Document the documentation process. Resent-From: Ludovic =?UTF-8?Q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Fri, 21 Jan 2022 21:07:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 53287 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: jgart Cc: 53287@debbugs.gnu.org Received: via spool by 53287-submit@debbugs.gnu.org id=B53287.16427992028463 (code B ref 53287); Fri, 21 Jan 2022 21:07:02 +0000 Received: (at 53287) by debbugs.gnu.org; 21 Jan 2022 21:06:42 +0000 Received: from localhost ([127.0.0.1]:35174 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nB17E-0002CJ-1H for submit@debbugs.gnu.org; Fri, 21 Jan 2022 16:06:41 -0500 Received: from hera.aquilenet.fr ([185.233.100.1]:34156) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nB17B-0002Bt-MN for 53287@debbugs.gnu.org; Fri, 21 Jan 2022 16:06:35 -0500 Received: from localhost (localhost [127.0.0.1]) by hera.aquilenet.fr (Postfix) with ESMTP id 0A49A3D7; Fri, 21 Jan 2022 22:06:27 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at aquilenet.fr Received: from hera.aquilenet.fr ([127.0.0.1]) by localhost (hera.aquilenet.fr [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 66AsKaZxyyTN; Fri, 21 Jan 2022 22:06:26 +0100 (CET) Received: from ribbon (91-160-117-201.subs.proxad.net [91.160.117.201]) by hera.aquilenet.fr (Postfix) with ESMTPSA id AD2991D2; Fri, 21 Jan 2022 22:06:25 +0100 (CET) From: Ludovic =?UTF-8?Q?Court=C3=A8s?= References: <20220115180847.31250-1-jgart@dismail.de> <20220115194521.2158-1-jgart@dismail.de> Date: Fri, 21 Jan 2022 22:06:25 +0100 In-Reply-To: <20220115194521.2158-1-jgart@dismail.de> (jgart@dismail.de's message of "Sat, 15 Jan 2022 14:45:22 -0500") Message-ID: <87wnis3ijy.fsf_-_@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Spamd-Bar: / X-Rspamd-Server: hera X-Rspamd-Queue-Id: 0A49A3D7 X-Spamd-Result: default: False [-0.10 / 15.00]; ARC_NA(0.00)[]; RCVD_VIA_SMTP_AUTH(0.00)[]; RCPT_COUNT_TWO(0.00)[2]; FROM_HAS_DN(0.00)[]; TO_DN_SOME(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; MIME_GOOD(-0.10)[text/plain]; FROM_EQ_ENVFROM(0.00)[]; MIME_TRACE(0.00)[0:+]; RCVD_COUNT_TWO(0.00)[2]; RCVD_TLS_ALL(0.00)[]; MID_RHS_MATCH_FROM(0.00)[] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+larch=yhetil.org@gnu.org Sender: "Guix-patches" X-Migadu-Flow: FLOW_IN X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1642800939; 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:resent-cc: resent-from:resent-sender:resent-message-id:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post; bh=Kga6vp9dVCl4w5UB9oEN4BIjyZmMnzca5cwCRE1POho=; b=QWJMCUPlWPBf/fQrkiukhkLi5m5hpqg3ZDMxOJITzOoLW0e1lh3mpsWyxlVZYwFuqw1V5l 4lHF7X9cG7PyCQQkxcKhfyE2/nU8COqUfMMX15HBxnRGi6MDC7xG5j4vcp0wDQb9MHONJU Owy0fnBkqd6qGjI4ShTRjKsBlgLtkCro/AcosDKZDMYWwMM3Hme5aFbkhq3Vjkt1EOqdCK 94O9WcimcgvuwGXSJSuCscnkNopiLnHev2djUyCmbIPR6dV0QGXQpie4z9Qy0AqfUVKt8b gjKZ4KiMY9Oa910MenWSVVxPvOObnKWnQAWDszp1N7/flw8EomiCWvchY0XhRw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1642800939; a=rsa-sha256; cv=none; b=B+v357AMCHQKVOwM0Mg4OxLZsoHH6OaLMBfSjKnWxNcHDIJqK8QmkmDaDRPSGiTLQqLqXc g7zqvKg3njHHvV8/Ag60/fNYM6nMZgrJucHwX4Z8fD+bzqWRfkSFDkceOCcDamEEf0oecB yJtXW0W7jndaPtATPwz+YX/yY3zfZW4yccyTsoLpYTtfmte41x1gPG9YXU4P4A/ExIVmZb bNcnzL+D0b1If36EgUgNvMBE3Oxej2iryl+jhZuck6bWpcmfCNaNo0lAIGfmaAy4lxJS4R bqQHkfIxFOvl5cIxuCzThrk7HMejnhC+MA7HCvpUyQl1IE816dJ1HrzPPj/f+w== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -4.63 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: 8745C10459 X-Spam-Score: -4.63 X-Migadu-Scanner: scn0.migadu.com X-TUID: 2pcJGR1KIsSE Hi! jgart skribis: > * doc/contributing.texi (Contributing): Add documentation documentation. > > Co-authored-by: jgart > Julien Lepiller > Matt Trzcinski > Fabio Natali > Gabor Boskovits That=E2=80=99s a much welcome addition! Overall it LGTM. I have minor comments to complement what zimoun already wrote: > --- a/doc/contributing.texi > +++ b/doc/contributing.texi > @@ -30,6 +30,7 @@ choice. > * Commit Access:: Pushing to the official repository. > * Updating the Guix Package:: Updating the Guix package definition. > * Translating Guix:: Make Guix speak your native language. > +* Documenting Guix:: Improving documentation in GNU Guix. > @end menu I=E2=80=99d move this section before =E2=80=9CTranslating Guix=E2=80=9D bec= ause that conceptually happens before. Note that you need to add the line above also in the other menus that show this section. In Emacs that=E2=80=99s M-x texinfo-all-menus-update I think, but otherwise you can copy/paste it by hand=E2=80=A6 (Menus are one= of the bad things of Texinfo.) Last, how about changing the title to =E2=80=9CWriting Documentation=E2=80= =9D or something along these lines? (In general I like to not repeat =E2=80=9CGui= x=E2=80=9D everywhere because it=E2=80=99s implicit.) > +Guix is documented using the Texinfo system. However, if you are not I=E2=80=99d remove =E2=80=9CHowever=E2=80=9D. > +To modify the documentation, you need to edit @file{doc/guix.texi} and > +@file{doc/contributing.texi} (which contains this documentation > +section), or @file{doc/guix-cookbook.texi} for the cookbook. If > +you compiled the Guix repository before, you will have > +many more @file{.texi} files that are translations of these > +documents. Do not modify them, the translation is managed through > +@uref{https://translate.fedoraproject.org/projects/guix, Weblate}, Replace comma with a period=E2=80=A6 > +@pxref{Translating Guix} for more information. =E2=80=A6 and pxref with xref. > +To render your documentation changes, we recommend to execute one of > +the following commands: What about: To render documentation, you must first make sure that you ran @command{./configure} in your source tree (@pxref{Running Guix Before It Is Installed}). After than you can run one of the following commands: ? > +@itemize > +@item @samp{make doc/guix.info} to compile the info manual. s/info manual/Info manual/ > +@item @samp{make doc/guix-cookbook.info} for the cookbook info manual. Likewise. Could you send an updated patch? Thumbs up to everyone who participated in this meetup! Ludo=E2=80=99.