From: Luis Felipe via Guix-patches via <guix-patches@gnu.org>
To: "53287@debbugs.gnu.org" <53287@debbugs.gnu.org>
Subject: [bug#53287] [PATCH] doc: Document the documentation process.
Date: Fri, 08 Apr 2022 18:26:54 +0000 [thread overview]
Message-ID: <g9ZUmzckZuQLZFM5lTXP9qxTXClj8JDjrmRQusl386M0LRLLsCo9vWJGWkYjEtwEh0JD2URIAXEfTeGhG8pqaL4G0MtLrW6-BWWoy9--UjY=@protonmail.com> (raw)
In-Reply-To: <20220115180847.31250-1-jgart@dismail.de>
[-- Attachment #1.1: Type: text/plain, Size: 128 bytes --]
Hi,
I attach an updated patch with the changes suggested by zimoun and Ludovic.
Cheers,
---
Luis Felipe López Acevedo
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: 0001-doc-Document-the-documentation-process.patch --]
[-- Type: text/x-patch; filename="0001-doc-Document-the-documentation-process.patch"; name="0001-doc-Document-the-documentation-process.patch", Size: 3213 bytes --]
From c808d0d2c20e659273e8019240a6391ed6a9f1da Mon Sep 17 00:00:00 2001
From: jgart <jgart@dismail.de>
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 <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 | 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
[-- Attachment #1.3: publickey - luis.felipe.la@protonmail.com - 0x12DE1598.asc --]
[-- Type: application/pgp-keys, Size: 1815 bytes --]
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 509 bytes --]
next prev parent reply other threads:[~2022-04-08 18:28 UTC|newest]
Thread overview: 10+ 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 ` [bug#53287] [PATCH v3] " jgart via Guix-patches via
2022-01-17 16:31 ` 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 ` Luis Felipe via Guix-patches via [this message]
2022-07-07 18:42 ` [bug#53287] [PATCH] doc: Document the documentation process Maxim Cournoyer
2022-07-07 21:41 ` Luis Felipe via Guix-patches via
2022-07-07 23:55 ` 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='g9ZUmzckZuQLZFM5lTXP9qxTXClj8JDjrmRQusl386M0LRLLsCo9vWJGWkYjEtwEh0JD2URIAXEfTeGhG8pqaL4G0MtLrW6-BWWoy9--UjY=@protonmail.com' \
--to=guix-patches@gnu.org \
--cc=53287@debbugs.gnu.org \
--cc=luis.felipe.la@protonmail.com \
/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).