[PATCH] doc: Document translation process.

  • Done
  • quality assurance status badge
Details
2 participants
  • Julien Lepiller
  • Ludovic Courtès
Owner
unassigned
Submitted by
Julien Lepiller
Severity
normal
J
J
Julien Lepiller wrote on 14 Apr 2021 00:48
(address . guix-patches@gnu.org)
20210414004857.2c560714@tachikoma.lepiller.eu
Hi Guix!

The attached patch adds a new section to the manual (and therefore
should wait for the next release since we are in string freeze) that
documents the translation process for contributors.
L
L
Ludovic Courtès wrote on 16 Apr 2021 23:08
(name . Julien Lepiller)(address . julien@lepiller.eu)(address . 47763@debbugs.gnu.org)
877dl22azq.fsf@gnu.org
Hi Julien,

Julien Lepiller <julien@lepiller.eu> skribis:

Toggle quote (12 lines)
> The attached patch adds a new section to the manual (and therefore
> should wait for the next release since we are in string freeze) that
> documents the translation process for contributors.
>
> From ce110d021935467753e0086c6992c45bf9a48388 Mon Sep 17 00:00:00 2001
> From: Julien Lepiller <julien@lepiller.eu>
> Date: Wed, 14 Apr 2021 00:16:01 +0200
> Subject: [PATCH] doc: Document translation process.
>
> doc/contributing.texi (Translating Guix): New section.
> doc/guix.texi (Top): Add a reference to the new section.

Excellent!

I have little to say, just some cosmetic comments:

Toggle quote (3 lines)
> +The manual and the cookbook both use texinfo. As for @code{packages}, please
> +keep texinfo markup as is. There are more possible markup types in the manual

s/texinfo/Texinfo/ (throughout)

Toggle quote (7 lines)
> +@subsubheading Outside of Weblate
> +
> +Currently, some parts of Guix cannot be translated on Weblate, help wanted!
> +
> +@itemize
> +@item Guix pull news can be translated in @file{news.scm}, but is not

s/Guix pull/@command{guix pull}

Toggle quote (5 lines)
> + available from Weblate. If you want to provide a translation, you
> + can prepare a patch as described above, or simply send us your
> + translation with the name of the news entry your translate and your
> + language.

Maybe add: “@xref{Writing Channel News}, for more information about
channel news.”

Toggle quote (2 lines)
> +@item Guix blog posts cannot currently be translated.

Since it’s Markdown, would po4a work for them?

Toggle quote (4 lines)
> +@item Some of the libraries Guix cannot be translated or are translated outside
> + of the Guix project. Guile itself does not provide a translation
> + mechanism.

A word is missing from the first sentence. You mean that Guile itself
and some of the libraries Guix relies on are not internationalized,
right?

Thanks for taking the time to document all this!

Ludo’.
J
J
Julien Lepiller wrote on 25 Apr 2021 16:04
(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 47763-done@debbugs.gnu.org)
20210425160413.0c95d5ad@tachikoma.lepiller.eu
Le Fri, 16 Apr 2021 23:08:41 +0200,
Ludovic Courtès <ludo@gnu.org> a écrit :

Toggle quote (24 lines)
> Hi Julien,
>
> Julien Lepiller <julien@lepiller.eu> skribis:
>
> > The attached patch adds a new section to the manual (and therefore
> > should wait for the next release since we are in string freeze) that
> > documents the translation process for contributors.
> >
> > From ce110d021935467753e0086c6992c45bf9a48388 Mon Sep 17 00:00:00
> > 2001 From: Julien Lepiller <julien@lepiller.eu>
> > Date: Wed, 14 Apr 2021 00:16:01 +0200
> > Subject: [PATCH] doc: Document translation process.
> >
> > doc/contributing.texi (Translating Guix): New section.
> > doc/guix.texi (Top): Add a reference to the new section.
>
> Excellent!
>
> I have little to say, just some cosmetic comments:
>
> > +@item Guix blog posts cannot currently be translated.
>
> Since it’s Markdown, would po4a work for them?

Indeed, it should be pretty easy, but the question is how to integrate
that process with weblate and the website (how to link an article to
its translations automatically, etc).

Toggle quote (11 lines)
>
> > +@item Some of the libraries Guix cannot be translated or are
> > translated outside
> > + of the Guix project. Guile itself does not provide a
> > translation
> > + mechanism.
>
> A word is missing from the first sentence. You mean that Guile itself
> and some of the libraries Guix relies on are not internationalized,
> right?

I changed the sentence to say that, thanks :)

Toggle quote (5 lines)
>
> Thanks for taking the time to document all this!
>
> Ludo’.

I pushed a slightly extended version after I fixed your remarks as
1897a6efa77e341a091e40140d02b525eabb3fdf. Thank you!
Closed
?