unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: jgart via Guix-patches via <guix-patches@gnu.org>
To: 53287@debbugs.gnu.org
Cc: jgart <jgart@dismail.de>
Subject: [bug#53287] [PATCH v3] doc: Document the documentation process.
Date: Sat, 15 Jan 2022 14:45:22 -0500	[thread overview]
Message-ID: <20220115194521.2158-1-jgart@dismail.de> (raw)
In-Reply-To: <20220115180847.31250-1-jgart@dismail.de>

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

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





  parent reply	other threads:[~2022-01-15 19:47 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-01-15 18:08 [bug#53287] [PATCH] doc: Document the documentation process jgart via Guix-patches via
2022-01-15 19:27 ` [bug#53287] [PATCH v2] " jgart via Guix-patches via
2022-01-15 19:45 ` jgart via Guix-patches via [this message]
2022-01-17 16:31   ` [bug#53287] [PATCH v3] " zimoun
2022-01-21 21:06   ` [bug#53287] [PATCH] " Ludovic Courtès
2022-01-25  7:27 ` [bug#53287] (no subject) jgart via Guix-patches via
2022-04-08 18:26 ` [bug#53287] [PATCH] doc: Document the documentation process Luis Felipe via Guix-patches via
2022-07-07 18:42   ` Maxim Cournoyer
2022-07-07 21:41     ` Luis Felipe via Guix-patches via
2022-07-07 23:55       ` jgart via Guix-patches via
2024-06-29  6:52         ` bug#53287: " jgart via Guix-patches via

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220115194521.2158-1-jgart@dismail.de \
    --to=guix-patches@gnu.org \
    --cc=53287@debbugs.gnu.org \
    --cc=jgart@dismail.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).