Re: [PATCH v2 1/2] docs: doc-guide: add a guide for translators

[Daniel Pereira]

On Sun, Oct 18, 2026 at 02:03 +0200, Federico Vaga wrote:
> The following chapters are somehow repeating what already written in
> other documents (doc-guide, process). Everyone should follow the
> process and the documentation guide, there should not be the need to
> repeat "how to write documentation" and "how to send patches".

Hi Federico,

Fair point, thanks. In v3 I will drop the generic parts of those
sections and link to Documentation/doc-guide/sphinx.rst and
Documentation/process/submitting-patches.rst instead.

I would like to keep only the points that are specific to
translations and that keep coming up in review, as short notes:

- a partial build with SPHINXDIRS=translations/<lang> hides label and
citation collisions with the English documents, so a full htmldocs
build is needed;
- tools/docs/checktransupdate.py, to check whether a translation is
out of date;
- the translation maintainers and lists to add as recipients, in
addition to the documentation maintainer.

Does that sound reasonable?

Thanks,
Daniel


Em sáb., 17 de out. de 2026 às 21:03, Federico Vaga
<federico.vaga@xxxxxxxxxx> escreveu:
>
> Hi Daniel,
>
> thank you for this effort, allow me one comment. The following chapters are
> somehow repeating what already written in other documents (doc-guide, process).
> Everyone should follow the process and the documentation guide, there should not be
> the need to repeat "how to write documentation" and "how to send patches".
>
> >+Building and checking your work
> >+===============================
> >+Build the documentation
> >+-----------------------
> >+Look at the result
> >+------------------
> >+Run checkpatch
> >+--------------
> >+Sending the patch
> >+=================
> >+Recipients
> >+----------
> >+Sending
> >+-------
> >+New versions
> >+------------
>
> --
> Federico Vaga
>