X-Loop: help-debbugs@HIDDEN Subject: [bug#53287] [PATCH] doc: Document the documentation process. Resent-From: jgart <jgart@HIDDEN> Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org> Resent-CC: guix-patches@HIDDEN Resent-Date: Sat, 15 Jan 2022 18:12:02 +0000 Resent-Message-ID: <handler.53287.B.164227026312706 <at> debbugs.gnu.org> Resent-Sender: help-debbugs@HIDDEN X-GNU-PR-Message: report 53287 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 53287 <at> debbugs.gnu.org Cc: Guix Together <jgart@HIDDEN> X-Debbugs-Original-To: guix-patches@HIDDEN Received: via spool by submit <at> debbugs.gnu.org id=B.164227026312706 (code B ref -1); Sat, 15 Jan 2022 18:12:02 +0000 Received: (at submit) by debbugs.gnu.org; 15 Jan 2022 18:11:03 +0000 Received: from localhost ([127.0.0.1]:41703 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>) id 1n8nVx-0003IT-4H for submit <at> debbugs.gnu.org; Sat, 15 Jan 2022 13:11:03 -0500 Received: from lists.gnu.org ([209.51.188.17]:38420) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from <jgart@HIDDEN>) id 1n8nVt-0003II-9b for submit <at> debbugs.gnu.org; Sat, 15 Jan 2022 13:10:56 -0500 Received: from eggs.gnu.org ([209.51.188.92]:50358) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from <jgart@HIDDEN>) id 1n8nVp-00063p-MA for guix-patches@HIDDEN; Sat, 15 Jan 2022 13:10:50 -0500 Received: from mx2.dismail.de ([159.69.191.136]:12860) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from <jgart@HIDDEN>) id 1n8nV6-0004il-F6 for guix-patches@HIDDEN; Sat, 15 Jan 2022 13:10:29 -0500 Received: from mx2.dismail.de (localhost [127.0.0.1]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 9b1e15fd for <guix-patches@HIDDEN>; Sat, 15 Jan 2022 19:09:57 +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=Oki05GBrZVRhYsC+BMHZR1+xfQ94azq6qIFxdh7limM=; b= Xhu+GJG6kpWtUgIXd8atIQF49ze4JHaWh2+fnS/KB9Uecp9mCpyc1GpSSrlt7PBP Xm7tTKNgmWdyXubd+c8lJN53VyChmYRoKt3/80Jxg5z2tY+AcyYtMB0gOHnX3mFR VbmktTH4loZuMj+knGv1EBw4Au7Luvt3dv5nDr0/G3z4YZRzuW+DtcQLetyP4duC QiSrQKbjFbG9mpSBHOR7La1QE63NTpPxwWPKrU8p71Cy/MKWzFYOm5sH8Nimb5R+ mr0TwI55gEjAEJjMxnaWVE7BOj/1KO8zixwCVw3B3arkjRBWotT8B0+bT0aOh0NK FBgo5F7+P5LkbuBpoFmShA== Received: from smtp2.dismail.de (<unknown> [10.240.26.12]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 245a2ac0 for <guix-patches@HIDDEN>; Sat, 15 Jan 2022 19:09:56 +0100 (CET) Received: from smtp2.dismail.de (localhost [127.0.0.1]) by smtp2.dismail.de (OpenSMTPD) with ESMTP id c5b6e6b4 for <guix-patches@HIDDEN>; Sat, 15 Jan 2022 19:09:56 +0100 (CET) Received: by dismail.de (OpenSMTPD) with ESMTPSA id 8bd59fda (TLSv1.3:AEAD-AES256-GCM-SHA384:256:NO); Sat, 15 Jan 2022 19:09:55 +0100 (CET) From: jgart <jgart@HIDDEN> Date: Sat, 15 Jan 2022 13:08:48 -0500 Message-Id: <20220115180847.31250-1-jgart@HIDDEN> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=159.69.191.136; envelope-from=jgart@HIDDEN; helo=mx2.dismail.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 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_MED=-2.3, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: -1.4 (-) X-BeenThere: debbugs-submit <at> debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: <debbugs-submit.debbugs.gnu.org> List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe> List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/> List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org> List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help> List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe> Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org> X-Spam-Score: -0.1 (/) From: Guix Together <jgart@HIDDEN> * doc/contributing.texi (Contributing): Add documentation documentation. Co-authored-by: jgart <jgart@HIDDEN> Julien Lepiller <julien@HIDDEN> Matt Trzcinski <matt@HIDDEN> Fabio Natali <me@HIDDEN> Gabor Boskovits <boskovits@HIDDEN> --- Hi Guixers, Here is our work from today's documentation meetup. all best, 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
Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.505 (Entity 5.505) Content-Type: text/plain; charset=utf-8 X-Loop: help-debbugs@HIDDEN From: help-debbugs@HIDDEN (GNU bug Tracking System) To: jgart <jgart@HIDDEN> Subject: bug#53287: Acknowledgement ([PATCH] doc: Document the documentation process.) Message-ID: <handler.53287.B.164227026312706.ack <at> debbugs.gnu.org> References: <20220115180847.31250-1-jgart@HIDDEN> X-Gnu-PR-Message: ack 53287 X-Gnu-PR-Package: guix-patches X-Gnu-PR-Keywords: patch Reply-To: 53287 <at> debbugs.gnu.org Date: Sat, 15 Jan 2022 18:12:02 +0000 Thank you for filing a new bug report with debbugs.gnu.org. This is an automatically generated reply to let you know your message has been received. Your message is being forwarded to the package maintainers and other interested parties for their attention; they will reply in due course. Your message has been sent to the package maintainer(s): guix-patches@HIDDEN If you wish to submit further information on this problem, please send it to 53287 <at> debbugs.gnu.org. Please do not send mail to help-debbugs@HIDDEN unless you wish to report a problem with the Bug-tracking system. --=20 53287: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D53287 GNU Bug Tracking System Contact help-debbugs@HIDDEN with problems
X-Loop: help-debbugs@HIDDEN Subject: [bug#53287] [PATCH v2] doc: Document the documentation process. References: <20220115180847.31250-1-jgart@HIDDEN> In-Reply-To: <20220115180847.31250-1-jgart@HIDDEN> Resent-From: jgart <jgart@HIDDEN> Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org> Resent-CC: guix-patches@HIDDEN Resent-Date: Sat, 15 Jan 2022 19:39:02 +0000 Resent-Message-ID: <handler.53287.B53287.164227549930821 <at> debbugs.gnu.org> Resent-Sender: help-debbugs@HIDDEN X-GNU-PR-Message: followup 53287 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 53287 <at> debbugs.gnu.org Cc: Gabor Boskovits <boskovits@HIDDEN>, Julien Lepiller <julien@HIDDEN>, jgart <jgart@HIDDEN>, Fabio Natali <me@HIDDEN>, Matt Trzcinski <matt@HIDDEN> Received: via spool by 53287-submit <at> 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 <debbugs-submit-bounces <at> debbugs.gnu.org>) id 1n8osO-00080t-F4 for submit <at> 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 <jgart@HIDDEN>) id 1n8osJ-00080P-N0 for 53287 <at> 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 (<unknown> [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) From: jgart <jgart@HIDDEN> Date: Sat, 15 Jan 2022 14:27:39 -0500 Message-Id: <20220115192738.1461-1-jgart@HIDDEN> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: -0.3 (/) X-BeenThere: debbugs-submit <at> debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: <debbugs-submit.debbugs.gnu.org> List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe> List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/> List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org> List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help> List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe> Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org> X-Spam-Score: 1.0 (+) * doc/contributing.texi (Contributing): Add documentation documentation. Co-authored-by: jgart <jgart@HIDDEN> Co-authored-by: Julien Lepiller <julien@HIDDEN> Co-authored-by: Matt Trzcinski <matt@HIDDEN> Co-authored-by: Fabio Natali <me@HIDDEN> Co-authored-by: Gabor Boskovits <boskovits@HIDDEN> --- 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
X-Loop: help-debbugs@HIDDEN Subject: [bug#53287] [PATCH v3] doc: Document the documentation process. References: <20220115180847.31250-1-jgart@HIDDEN> In-Reply-To: <20220115180847.31250-1-jgart@HIDDEN> Resent-From: jgart <jgart@HIDDEN> Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org> Resent-CC: guix-patches@HIDDEN Resent-Date: Sat, 15 Jan 2022 19:47:01 +0000 Resent-Message-ID: <handler.53287.B53287.164227596631685 <at> debbugs.gnu.org> Resent-Sender: help-debbugs@HIDDEN X-GNU-PR-Message: followup 53287 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 53287 <at> debbugs.gnu.org Cc: jgart <jgart@HIDDEN> Received: via spool by 53287-submit <at> 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 <debbugs-submit-bounces <at> debbugs.gnu.org>) id 1n8ozw-0008EL-I4 for submit <at> 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 <jgart@HIDDEN>) id 1n8ozr-0008Ds-Th for 53287 <at> 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 <at> 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 (<unknown> [10.240.26.12]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 75c2a63d for <53287 <at> 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 <at> 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) From: jgart <jgart@HIDDEN> Date: Sat, 15 Jan 2022 14:45:22 -0500 Message-Id: <20220115194521.2158-1-jgart@HIDDEN> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Score: -2.3 (--) X-BeenThere: debbugs-submit <at> debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: <debbugs-submit.debbugs.gnu.org> List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe> List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/> List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org> List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help> List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe> Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org> X-Spam-Score: -1.0 (-) * doc/contributing.texi (Contributing): Add documentation documentation. Co-authored-by: jgart <jgart@HIDDEN> Julien Lepiller <julien@HIDDEN> Matt Trzcinski <matt@HIDDEN> Fabio Natali <me@HIDDEN> Gabor Boskovits <boskovits@HIDDEN> --- 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
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997 nCipher Corporation Ltd,
1994-97 Ian Jackson.