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

From: Weijie Yuan

Date: Thu Oct 15 2026 - 09:39:32 EST


On 2026-10-15 09:55:58 -0300, Daniel Pereira <danielmaraboo@xxxxxxxxx>
wrote:

> Hi Weijie,
>
> On Thu, Oct 15, 2026 at 19:32 +0800, Weijie Yuan <wy@xxxxxxxxx> wrote:
> > Thanks for doing this.
>
> Thanks a lot for the review, and for confirming that a guide like this
> was missing.
>
> > Current practice of the field Original in zh_CN is:
> >
> > :Original: Documentation/xxx/xxx.rst
>
> Agreed. The example now uses a plain path, and the guide notes that the
> documentation build turns "Documentation/..." paths into links on its
> own.
>
> > For the Translator field, zh_TW just did a cleanup to totally remove
> > them.
>
> Makes sense. I dropped the ":Translator:" line from the example, and the
> guide keeps the advice to leave contact information to MAINTAINERS.

I personally think this is somehow a hard tradeoff, so my opinion is
rather neutral, and I respect your decisions.

On the one hand, I think keeping this field is indeed a way to give
credit to the contributors, which can motivate more contributions and
contributors. On the other hand, over the years, this field has seemed a
bit cumbersome and inconsistent in both Chinese translations.

>
> > Requirement for "Assisted-by" trailer has been changed recently. ;-)
>
> Right, I missed that. All the Assisted-by references are gone from the
> guide (the AI tools section, the tags example and the checklist); it now
> only says that Signed-off-by can only be added by the human who
> certifies the contribution.
>
> > Shall we Cc all the maintainers of translations for more comments?
>
> Yes, good idea. I have prepared a v2 with these changes, rebased on
> docs-next, and I am sending it with all the translation maintainers in
> Cc, so that every team can comment.

Thanks!