GNU bug report logs - #53287
[PATCH] doc: Document the documentation process.

Previous Next

Full log

View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: jgart <jgart <at> dismail.de>
Subject: bug#53287: closed (Re: [PATCH] doc: Document the documentation
 process.)
Date: Sat, 29 Jun 2024 06:53:02 +0000

[Message part 1 (text/plain, inline)]

Your bug report

#53287: [PATCH] doc: Document the documentation process.

which was filed against the guix-patches package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to 53287 <at> debbugs.gnu.org.

-- 
53287: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=53287
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems

[Message part 2 (message/rfc822, inline)]

From: jgart <jgart <at> dismail.de>
To: 53287-done <at> debbugs.gnu.org
Cc: Ludovic Courtès <ludo <at> gnu.org>, jgart <jgart <at> dismail.de>,
 Luis Felipe <luis.felipe.la <at> protonmail.com>,
 Maxim Cournoyer <maxim.cournoyer <at> gmail.com>, zimoun <zimon.toutoune <at> gmail.com>
Subject: Re: [PATCH] doc: Document the documentation process.
Date: Sat, 29 Jun 2024 01:52:44 -0500

Hi all,

I'm closing this issue since it looks like Maxim merged a commit a while
ago resolving it. Thanks!

all best,

jgart

[Message part 3 (message/rfc822, inline)]

From: jgart <jgart <at> dismail.de>
To: guix-patches <at> gnu.org
Cc: Guix Together <jgart <at> dismail.de>
Subject: [PATCH] doc: Document the documentation process.
Date: Sat, 15 Jan 2022 13:08:48 -0500

From: Guix Together <jgart <at> dismail.de>

* doc/contributing.texi (Contributing): Add documentation documentation.

Co-authored-by: jgart <jgart <at> dismail.de>
Julien Lepiller <julien <at> lepiller.eu>
Matt Trzcinski <matt <at> excalamus.com>
Fabio Natali <me <at> fabionatali.com>
Gabor Boskovits <boskovits <at> gmail.com>
---

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

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.