From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.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 aAaYEuQk42EhAQEAgWs5BA (envelope-from ) for ; Sat, 15 Jan 2022 20:47:48 +0100 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id IJwQEOQk42HOewEA9RJhRA (envelope-from ) for ; Sat, 15 Jan 2022 20:47:48 +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 CCC084374E for ; Sat, 15 Jan 2022 20:47:47 +0100 (CET) Received: from localhost ([::1]:60042 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1n8p1d-0004Oh-0l for larch@yhetil.org; Sat, 15 Jan 2022 14:47:45 -0500 Received: from eggs.gnu.org ([209.51.188.92]:46542) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n8p0x-0004Jl-6j for guix-patches@gnu.org; Sat, 15 Jan 2022 14:47:04 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:49025) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1n8p0v-00040j-NV for guix-patches@gnu.org; Sat, 15 Jan 2022 14:47:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1n8p0v-0008Gn-Lj for guix-patches@gnu.org; Sat, 15 Jan 2022 14:47:01 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#53287] [PATCH v3] 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:47:01 +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: jgart Received: via spool by 53287-submit@debbugs.gnu.org id=B53287.164227596631685 (code B ref 53287); Sat, 15 Jan 2022 19:47:01 +0000 Received: (at 53287) by debbugs.gnu.org; 15 Jan 2022 19:46:06 +0000 Received: from localhost ([127.0.0.1]:41919 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n8ozw-0008EL-I4 for submit@debbugs.gnu.org; Sat, 15 Jan 2022 14:46:05 -0500 Received: from mx2.dismail.de ([159.69.191.136]:20504) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n8ozr-0008Ds-Th for 53287@debbugs.gnu.org; Sat, 15 Jan 2022 14:45:58 -0500 Received: from mx2.dismail.de (localhost [127.0.0.1]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 65ea5ad6 for <53287@debbugs.gnu.org>; Sat, 15 Jan 2022 20:45:49 +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=GuxCS4oUyMhaassmeDyz3+BPXZuTPnJJDAM3OvI2KmY=; b= DjYePmwuCoIcFsIj7+GR4C5IJvE5bKFcVS+tfo6+MYTTu9IGb7wiYt5dNeCZh0+c DVdCu0xAZ6S0Yc8R++xHDSLQhDZ0Gubix26do2xUc2ksITfuz8CgdoIp0u8YZ/XW yh2Rp3xiFRNLxxPFdR1VKFNucdgB4UtJo5co8p42/GuHJTSJdB6SeFWQKvxpGy5q kLaeqHSaLfVjOhi9aIVYN3I6b54/Kx23bz2Jxt4ElRUEkQWsJt5La1dJRhscZLul UsmxFcMG8QMBC5PA8vcB5i7m02Oy7u3DjiulXccrIv9BJMFWyKEhIWsmpx3McsCm x7J2reZ5vBxjQvGxtef3PQ== Received: from smtp2.dismail.de ( [10.240.26.12]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 75c2a63d for <53287@debbugs.gnu.org>; Sat, 15 Jan 2022 20:45:49 +0100 (CET) Received: from smtp2.dismail.de (localhost [127.0.0.1]) by smtp2.dismail.de (OpenSMTPD) with ESMTP id 64227479 for <53287@debbugs.gnu.org>; Sat, 15 Jan 2022 20:45:48 +0100 (CET) Received: by dismail.de (OpenSMTPD) with ESMTPSA id 8b32a703 (TLSv1.3:AEAD-AES256-GCM-SHA384:256:NO); Sat, 15 Jan 2022 20:45:42 +0100 (CET) Date: Sat, 15 Jan 2022 14:45:22 -0500 Message-Id: <20220115194521.2158-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=1642276067; 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=iDrg/rR8i/vK/wbX6ELAZHcg4tTIW1a2GRCcVKJHaCE=; b=brOt2HNMyOQes9L0ZFFMR0C4Uk2nrX7dQY73tkxfAF+rQq7Dv6ZhOukgd8khRcud8bQtUM eoNNTzqkrrqzqLs2tIx7//9J8xwdUXcb2Pg2lRRR+dSLsUlVd0/sgw8xQ/4SrxCVdE1xlL xCWcFWOS3ACXE9ySJI1gwgRpKhEcjfQZg9n8PgtHFJzxBy0wFGJMTpYKbVJ/+rXFPhuaVh 6pBxBmqDpqLdP+iI5aBPRuxgQ9b8tA654CVaJt+BTiuTbn8wogm776zroSteArtrj3hWw9 BwWGGhL9406XWl6e+azg+W4qAhSmXbm7tcLVokNEEwldpXVcTSWxalDPseUUeQ== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1642276067; a=rsa-sha256; cv=none; b=CgwkbP9sYgt1uPjerfQKFc1HD4O0C5aarN7KX7Huts3oBNK5xl9SA5DIk+1jDSVCeTdKAj MuLbqI+g8mJjcXw2iJJEzkhU5ZTIJpg4sOAJu+tRlavl8B65vgFaKvngDJrCEpXJfwTpZm cZiOR9r98C3uqM2ftHQdxSHZV6rYSuqqNd6z2wc3V7jQ5o/S2JySzet1LgTDULQDu+/SJQ A8RoyQst94g00fyimgxBLQIlMR1a5AEmQ7IqZu+tnLhNjNSq3RP6B6rcSjRO3DuYXiLTtw 0+3uv9mUk/3e4uZ8dgKZ97hvGPJcwe/fUOxNfwgWmVfku1E3md2QXtnmfmi/Aw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=dismail.de header.s=20190914 header.b=DjYePmwu; 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.42 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=dismail.de header.s=20190914 header.b=DjYePmwu; 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: CCC084374E X-Spam-Score: -4.42 X-Migadu-Scanner: scn0.migadu.com X-TUID: xvBykTNEgWVc * doc/contributing.texi (Contributing): Add documentation documentation. Co-authored-by: jgart Julien Lepiller Matt Trzcinski Fabio Natali Gabor Boskovits --- doc/contributing.texi | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/doc/contributing.texi b/doc/contributing.texi index 9f97788c0b..84ac478269 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, etc... + +Documentation contributions can be sent to +@email{guix-patches@@gnu.org}. Prepend @samp{[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 @samp{make doc/guix.info} to compile the info manual. + You can check it with @command{info doc/guix.info}. +@item @samp{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 @samp{make doc/guix-cookbook.info} for the cookbook info manual. +@item @samp{make doc/guix-cookbook.html} for the cookbook HTML version. +@end itemize + -- 2.34.1