From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id kLljAuYi42Gs8gAAgWs5BA (envelope-from ) for ; Sat, 15 Jan 2022 20:39:18 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id KO24NuUi42H2aAEAG6o9tA (envelope-from ) for ; Sat, 15 Jan 2022 20:39:17 +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 95C1830FF3 for ; Sat, 15 Jan 2022 20:39:17 +0100 (CET) Received: from localhost ([::1]:53580 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1n8otP-00082l-Dh for larch@yhetil.org; Sat, 15 Jan 2022 14:39:16 -0500 Received: from eggs.gnu.org ([209.51.188.92]:44174) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n8otC-00082E-Df for guix-patches@gnu.org; Sat, 15 Jan 2022 14:39:02 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:48999) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1n8otC-0002PZ-40 for guix-patches@gnu.org; Sat, 15 Jan 2022 14:39:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1n8otC-00082M-2u for guix-patches@gnu.org; Sat, 15 Jan 2022 14:39:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#53287] [PATCH v2] doc: Document the documentation process. References: <20220115180847.31250-1-jgart@dismail.de> In-Reply-To: <20220115180847.31250-1-jgart@dismail.de> Resent-From: jgart Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sat, 15 Jan 2022 19:39: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: 53287@debbugs.gnu.org Cc: Gabor Boskovits , Julien Lepiller , jgart , Fabio Natali , Matt Trzcinski Received: via spool by 53287-submit@debbugs.gnu.org id=B53287.164227549930821 (code B ref 53287); Sat, 15 Jan 2022 19:39:02 +0000 Received: (at 53287) by debbugs.gnu.org; 15 Jan 2022 19:38:19 +0000 Received: from localhost ([127.0.0.1]:41896 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n8osO-00080t-F4 for submit@debbugs.gnu.org; Sat, 15 Jan 2022 14:38:19 -0500 Received: from mx2.dismail.de ([159.69.191.136]:22149) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n8osJ-00080P-N0 for 53287@debbugs.gnu.org; Sat, 15 Jan 2022 14:38:10 -0500 Received: from mx2.dismail.de (localhost [127.0.0.1]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 5a7b94f0; Sat, 15 Jan 2022 20:38:00 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed; d=dismail.de; h=from:to:cc :subject:date:message-id:mime-version:content-transfer-encoding; s=20190914; bh=ytayzim6pBbg9gYkgi5ZJcCvOJOCC8QwAhxwY7PaKCI=; b= pIjBHXGGfhjTdmhXlIavzh4w5I/kM0xohCkTVF1sxlkUvsL7bIGycEx2kk+lrSwB W7mi3W2nyvbbyIodXzdDi/i8hpa4l7BlyaKs8MqbFq4CPESNMyyHQ+bLPjq5CGSO ZDhq/bOKpwB2N68Q40yxocHGB/bsLcLHnXN1QGxOBVNgKlOOrIIB7lV7NM/Xp00S x1VEqqxkihKOY4SnRpayTKNfDI+FJfYORln80UdcBYMk5N7AEAn0SMBaqwYSTYQU Fd1vCWXhVm6z7eC27MIUujd4hQkxBBA34fqVb+Dj/f3SJ/1QYZhr/ewmkQpgylHU V8Tptgi0WNxIqrIqJ7DXnw== Received: from smtp1.dismail.de ( [10.240.26.11]) by mx2.dismail.de (OpenSMTPD) with ESMTP id da2d8611; Sat, 15 Jan 2022 20:38:00 +0100 (CET) Received: from smtp1.dismail.de (localhost [127.0.0.1]) by smtp1.dismail.de (OpenSMTPD) with ESMTP id b849561c; Sat, 15 Jan 2022 20:38:00 +0100 (CET) Received: by dismail.de (OpenSMTPD) with ESMTPSA id d74544da (TLSv1.3:AEAD-AES256-GCM-SHA384:256:NO); Sat, 15 Jan 2022 20:37:58 +0100 (CET) Date: Sat, 15 Jan 2022 14:27:39 -0500 Message-Id: <20220115192738.1461-1-jgart@dismail.de> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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" Reply-to: jgart X-ACL-Warn: , jgart via Guix-patches From: jgart via Guix-patches via 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=1642275557; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: 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:dkim-signature; bh=eg/CxbHWmtZ4fYOTSolkrFk1wCFHj5lqlCRFailFvUw=; b=X4Xj7qEebqhWJrZOLjBe0TkQDduTNzVa3rV0Ps3fkzRmxwBbLH3nkPsSlKKV+ZFelksTnZ CqL2Fz/8NcRBinUhnjPJ2cWV3iP2JllVIGmDfk+Y95za03xpbLUTpK0AklWYcoa4ow+TKG +mjNdiK5Cs3VcDrlIu8hMq2vuDMTjAD4fleJNh6vcJhO3D7vqe06t4nXyxEAQ6Xbn2GWHH lhB1fV5WDjQX/2rySVbq+d8BQSELkBpq4NrydvcVLBVdkM5eosU+NmPryVLluq408Qgydj JdU7PQXOXWgZ9y/g1a3q2VAn0BxVQiaEVQhFOMrq65U1A4ee5zo26giafTNpOQ== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1642275557; a=rsa-sha256; cv=none; b=OGea2iaPBumryzLaK/lxwmL8vCyL0YYDgUfLvDROK4dsK4QaroPb5TXZLjkrGhHxqPZ9vC JTjR7zktR3h8yNFFwuHM1jhgZKhfAGYoC9iHAPcUyKVu18LcwXGKk8QXuGLhwflFZELaKS 9S8NEQqrMEDlx/MjFvi+vlsddlfum6/5TNOl1FhD4NBpkeLBbDRW9qmqbiOTWhyrfqH7Bw n8M0JjcChCY8l9TFICeEnAjlHTc6z7VDVgMDrH1T5IZ622EOTwwc78uvHkhjuYl+XVhHvy KnyAlKllwDXeCTl1fwzxDNRsd1BFaLjYFs+5o6vBKyvU36Fd7FEYc7PTg7JVEQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=dismail.de header.s=20190914 header.b=pIjBHXGG; 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: -3.32 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=dismail.de header.s=20190914 header.b=pIjBHXGG; 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: 95C1830FF3 X-Spam-Score: -3.32 X-Migadu-Scanner: scn1.migadu.com X-TUID: y3z6ydGopy3w * doc/contributing.texi (Contributing): Add documentation documentation. Co-authored-by: jgart Co-authored-by: Julien Lepiller Co-authored-by: Matt Trzcinski Co-authored-by: Fabio Natali Co-authored-by: Gabor Boskovits --- Here's a small fix that ngz suggested over irc. I also changed the committer to whereiseveryone and the email to use our public inbox instead of my own personal email. The commit "Co-authored-by:" statements where also missing from the previous patch. It had just the co-author's name and emails that I had pasted. all best, jgart https://whereiseveryone.srht.site/ gemini://whereiseveryone.srht.site/ doc/contributing.texi | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/doc/contributing.texi b/doc/contributing.texi index 9f97788c0b..101b693412 100644 --- 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 @node Building from Git @@ -1905,3 +1906,43 @@ differs for the various components. be updated accordingly (see @file{website/i18n-howto.txt} for more information on the process). @end itemize + +@cindex documentation +@node Documenting Guix +@section Documenting Guix + +Guix is documented using the Texinfo system. However, if you are not +yet familiar with it, we accept contributions for documentation in most +formats. That includes plain text, markdown, org-mode, etc... + +Documentation contributions can be sent to +@email{guix-patches@@gnu.org}. Prepend @code{[DOCUMENTATION]} to the +subject. + +When you need to make more than a simple addition to the documentation, +we prefer that you send a proper patch as opposed to sending an email +as described above. @xref{Submitting Patches} for more information on +how to send your patches. + +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}, +@pxref{Translating Guix} for more information. + +To render your documentation changes, we recommend to execute one of +the following commands: + +@itemize +@item @command{make doc/guix.info} to compile the info manual. + You can check it with @command{info doc/guix.info}. +@item @command{make doc/guix.html} to compile the HTML version. + You can point your browser to the relevant file in the + @file{doc/guix.html} directory. +@item @command{make doc/guix-cookbook.info} for the cookbook info manual. +@item @command{make doc/guix-cookbook.html} for the cookbook HTML version. +@end itemize + -- 2.34.1