Linux Documentation
 help / color / mirror / Atom feed
From: Weijie Yuan <wy@wyuan.org>
To: Daniel Pereira <danielmaraboo@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>,
	Shuah Khan <skhan@linuxfoundation.org>,
	Randy Dunlap <rdunlap@infradead.org>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 1/2] docs: doc-guide: add a guide for translators
Date: Thu, 15 Oct 2026 21:31:49 +0800	[thread overview]
Message-ID: <atDVxZQUiJfsqEBr@wyuan.org> (raw)
In-Reply-To: <CAMAsx6eef_2Gcf_WhvTkFWz-fOjyaWjP+h3US0v1=w-W5RdHBQ@mail.gmail.com>

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

> Hi Weijie,
> 
> On Thu, Oct 15, 2026 at 19:32 +0800, Weijie Yuan <wy@wyuan.org> 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!

  reply	other threads:[~2026-10-15 13:31 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-13  0:37 [PATCH 0/2] docs: add a guide for translators Daniel Pereira
2026-10-13  0:37 ` [PATCH 1/2] docs: doc-guide: " Daniel Pereira
2026-10-15 11:32   ` Weijie Yuan
2026-10-15 12:55     ` Daniel Pereira
2026-10-15 13:31       ` Weijie Yuan [this message]
2026-10-15 13:50         ` Jonathan Corbet
2026-10-15 14:03           ` Weijie Yuan
2026-10-15 14:17             ` Dongliang Mu
2026-10-13  0:37 ` [PATCH 2/2] docs: pt_BR: translate doc-guide/translations.rst Daniel Pereira

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=atDVxZQUiJfsqEBr@wyuan.org \
    --to=wy@wyuan.org \
    --cc=corbet@lwn.net \
    --cc=danielmaraboo@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=skhan@linuxfoundation.org \
    /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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox