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

From: Daniel Pereira

Date: Sun Oct 25 2026 - 09:10:56 EST


(Resending to the list: my previous reply went only to Dongliang.)

On Sun, Oct 25, 2026 at 11:22 +0800, Dongliang Mu wrote:
> Good job. I will quickly verify them and send a patch to move them.

Thanks. To avoid overlap, could you confirm which languages your patch
covers? I understand zh_CN, and that zh_TW is already handled by
Chen-Yu's series. That leaves:

- sp_SP: process/magic-number.rst and wrappers/memory-barriers.rst;
- the .txt files in ja_JP and ko_KR (stable_api_nonsense.txt and
stable_kernel_rules.txt), which I think are for their maintainers
to convert or drop.

> It seems the original English documentation moves fast. I would
> write a script or skill to check this relationship maybe daily or
> weekly.

A periodic check like that would be useful, especially once the guide
states the path mirroring as a rule.

For v3 of the guide, this is what I plan, based on the discussion so
far:

- state the path mirroring as a rule for translations of English
documents, and exempt documents that exist only in a translation,
such as a glossary or a language-specific how-to (Chen-Yu);
- describe ":Original:" as optional, and not needed when the path
mirrors the original, instead of showing it in the header example
(Jani, Weijie, Dongliang);
- drop the generic parts of the sections on writing documentation
and sending patches, and link to doc-guide/sphinx.rst and
process/submitting-patches.rst instead, keeping only the points
specific to translations (Federico).

Federico, I did not see an answer to my last message about this last
point. Is keeping those short translation-specific notes fine with you?

Since v3 only states the rule and does not depend on the moves, I
intend to send it without waiting for them to land. Dongliang, you
suggested removing ":Original:" only after all translations follow
the style; v3 only says it is optional, so I believe this is
compatible. Please tell me if you would rather I wait.

If anyone has other comments on v2 that I have not covered, please
let me know. I will send v3 in a few days.

Thanks,
Daniel