From patchwork Fri Apr 8 18:26:54 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Luis Felipe X-Patchwork-Id: 38447 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 6C81327BBEA; Fri, 8 Apr 2022 19:28:10 +0100 (BST) 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,FREEMAIL_FROM,MAILING_LIST_MULTI,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 E068027BBE9 for ; Fri, 8 Apr 2022 19:28:09 +0100 (BST) Received: from localhost ([::1]:35168 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nctL7-0000BJ-4c for patchwork@mira.cbaines.net; Fri, 08 Apr 2022 14:28:09 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:43676) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nctL0-0000BA-Ig for guix-patches@gnu.org; Fri, 08 Apr 2022 14:28:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:42028) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nctL0-0002VB-9q for guix-patches@gnu.org; Fri, 08 Apr 2022 14:28:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1nctL0-0003im-3y for guix-patches@gnu.org; Fri, 08 Apr 2022 14:28:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#53287] [PATCH] doc: Document the documentation process. References: <20220115180847.31250-1-jgart@dismail.de> In-Reply-To: <20220115180847.31250-1-jgart@dismail.de> Resent-From: Luis Felipe Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Fri, 08 Apr 2022 18:28: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" <53287@debbugs.gnu.org> Received: via spool by 53287-submit@debbugs.gnu.org id=B53287.164944243814246 (code B ref 53287); Fri, 08 Apr 2022 18:28:02 +0000 Received: (at 53287) by debbugs.gnu.org; 8 Apr 2022 18:27:18 +0000 Received: from localhost ([127.0.0.1]:35925 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nctKC-0003ha-BS for submit@debbugs.gnu.org; Fri, 08 Apr 2022 14:27:18 -0400 Received: from mail-4318.protonmail.ch ([185.70.43.18]:56391) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1nctK7-0003hC-VZ for 53287@debbugs.gnu.org; Fri, 08 Apr 2022 14:27:11 -0400 Date: Fri, 08 Apr 2022 18:26:54 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail; t=1649442418; bh=vq/do9PYQyXd6710ZswavkiAMKy6aJGVFZ0yUNp8fu8=; h=Date:To:From:Reply-To:Subject:Message-ID:From:To:Cc:Date:Subject: Reply-To:Feedback-ID:Message-ID; b=nLqGPbwbjnIFXNTtwgPIIzf0VZSBZGkXFEbbei8v4eUa1E2NN92lcKORRUX0HNqui Em1z2VTp5BcB9iLJrT2ZLBAMdiYXdXEfiz4S4T6tJfDEDbshqSILgoeawTTT7w5wM6 p0+liY/N6wW32q9c08e8New+y2N9icLsTf92AQpx9ffSotaUn0jnWDYFyisDSbOrWs IvBKKRsDVS9rPTYCPO7iHVMZJYlRCVJRSgQA1L+OhkUu5duapXDivGaMk9UyhRuj5G ckf4vdZl01hp3sLlO7tlrNv+kjYM3VqwXJX98k5c2S9/sLcqbCxExmAJzaeFNFQ7X4 BoR1t4jS0IDpw== Message-ID: MIME-Version: 1.0 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: Luis Felipe X-ACL-Warn: , Luis Felipe via Guix-patches X-Patchwork-Original-From: Luis Felipe via Guix-patches via From: Luis Felipe X-getmail-retrieved-from-mailbox: Patches Hi, I attach an updated patch with the changes suggested by zimoun and Ludovic. Cheers, --- Luis Felipe López Acevedo From c808d0d2c20e659273e8019240a6391ed6a9f1da Mon Sep 17 00:00:00 2001 From: jgart Date: Sat, 15 Jan 2022 14:45:22 -0500 Subject: [PATCH] doc: Document the documentation process. * doc/contributing.texi (Contributing): Add Writing Documentation section. Co-authored-by: jgart Julien Lepiller Matt Trzcinski Fabio Natali Gabor Boskovits --- doc/contributing.texi | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/doc/contributing.texi b/doc/contributing.texi index 862dcbf12a..3a7b6e6012 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -29,6 +29,7 @@ choice. * Tracking Bugs and Patches:: Keeping it all organized. * Commit Access:: Pushing to the official repository. * Updating the Guix Package:: Updating the Guix package definition. +* Writing Documentation:: Improving documentation in GNU Guix. * Translating Guix:: Make Guix speak your native language. @end menu @@ -1697,6 +1698,47 @@ This check can be disabled, @emph{at your own peril}, by setting the this variable is set, the updated package source is also added to the store. This is used as part of the release process of Guix. +@cindex documentation +@node Writing Documentation +@section Writing Documentation + +Guix is documented using the Texinfo system. 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}. +@xref{Translating Guix} for more information. + +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 that you can run 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 + @cindex translation @cindex l10n @cindex i18n -- 2.34.0