From patchwork Sat Jan 15 18:08:48 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: jgart X-Patchwork-Id: 36393 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id E043027BBEA; Sat, 15 Jan 2022 18:13:10 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL, SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 6423327BBE9 for ; Sat, 15 Jan 2022 18:13:10 +0000 (GMT) Received: from localhost ([::1]:38984 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1n8nY5-0007bw-HA for patchwork@mira.cbaines.net; Sat, 15 Jan 2022 13:13:09 -0500 Received: from eggs.gnu.org ([209.51.188.92]:50656) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n8nX1-0006qK-8S for guix-patches@gnu.org; Sat, 15 Jan 2022 13:12:03 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:48800) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1n8nX0-0006BG-Us for guix-patches@gnu.org; Sat, 15 Jan 2022 13:12:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1n8nX0-0003KG-N4 for guix-patches@gnu.org; Sat, 15 Jan 2022 13:12:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#53287] [PATCH] doc: Document the documentation process. Resent-From: jgart Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sat, 15 Jan 2022 18:12:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 53287 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 53287@debbugs.gnu.org Cc: Guix Together X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@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 ) id 1n8nVx-0003IT-4H for submit@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 ) id 1n8nVt-0003II-9b for submit@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 ) id 1n8nVp-00063p-MA for guix-patches@gnu.org; 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 ) id 1n8nV6-0004il-F6 for guix-patches@gnu.org; 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 ; 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 ( [10.240.26.12]) by mx2.dismail.de (OpenSMTPD) with ESMTP id 245a2ac0 for ; 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 ; 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) Date: Sat, 15 Jan 2022 13:08:48 -0500 Message-Id: <20220115180847.31250-1-jgart@dismail.de> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Received-SPF: pass client-ip=159.69.191.136; envelope-from=jgart@dismail.de; 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-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+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" Reply-to: jgart X-ACL-Warn: , jgart via Guix-patches X-Patchwork-Original-From: jgart via Guix-patches via From: jgart X-getmail-retrieved-from-mailbox: Patches From: Guix Together * doc/contributing.texi (Contributing): Add documentation documentation. Co-authored-by: jgart Julien Lepiller Matt Trzcinski Fabio Natali Gabor Boskovits --- 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 +