All of lore.kernel.org
 help / color / mirror / Atom feed
From: Daniel Pereira <danielmaraboo@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>,
	Randy Dunlap <rdunlap@infradead.org>, Alex Shi <alexs@kernel.org>,
	Yanteng Si <si.yanteng@linux.dev>,
	Dongliang Mu <dzm91@hust.edu.cn>,
	Chen-Yu Yeh <chenyou910331@gmail.com>, Weijie Yuan <wy@wyuan.org>,
	Federico Vaga <federico.vaga@vaga.pv.it>,
	Akira Yokosawa <akiyks@gmail.com>,
	Carlos Bilbao <carlos.bilbao@kernel.org>,
	Jani Nikula <jani.nikula@linux.intel.com>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	Daniel Pereira <danielmaraboo@gmail.com>
Subject: [PATCH v3 0/2] docs: add a guide for translators
Date: Thu, 19 Nov 2026 01:10:07 -0300	[thread overview]
Message-ID: <20261119041009.63651-1-danielmaraboo@gmail.com> (raw)

The documentation has seven translations, but the English documentation
has no guide on how to contribute to them; the only one that exists,
Documentation/translations/zh_CN/how-to.rst, is in Chinese and covers
zh_CN only.

Patch 1 adds Documentation/doc-guide/translations.rst, a guide that
covers the whole workflow of a translation.

Patch 2 translates the guide into Brazilian Portuguese.

Both patches were checked with a full "make htmldocs" build, with no
new warnings, and with scripts/checkpatch.pl --strict.

Changes in v3:
- State the path-mirroring rule explicitly, and exempt documents that
  exist only in a translation, such as a glossary or a language-specific
  how-to (Chen-Yu, Dongliang, Weijie).
- Make ":Original:" optional, needed only when the path does not mirror
  the original, and drop it from the header example (Jani, Weijie,
  Dongliang).
- Drop the sections that duplicated Documentation/doc-guide/sphinx.rst
  and Documentation/process/submitting-patches.rst, keeping only the
  points specific to translations, and link to those documents instead
  (Federico, Jon).
- Encourage translators to send a fix for the English original when
  they find a problem in it while translating (Jon).
- Mention b4 as an alternative for preparing and sending a patch series
  (Weijie).
- Carry Carlos Bilbao's Acked-by on the cover of v2 over to both
  patches, even though patch 1 changed significantly; please shout if
  you would rather re-review it.
- Cc Jani Nikula directly, since v3 follows his suggestion.
- Drop avadhut.naik@amd.com from the recipients; the address bounced
  twice on v2.

v2: https://lore.kernel.org/linux-doc/20261015125644.12908-1-danielmaraboo@gmail.com/
v1: https://lore.kernel.org/linux-doc/20261013003702.5824-1-danielmaraboo@gmail.com/

Daniel Pereira (2):
  docs: doc-guide: add a guide for translators
  docs: pt_BR: translate doc-guide/translations.rst

 Documentation/doc-guide/index.rst             |   1 +
 Documentation/doc-guide/translations.rst      | 652 +++++++++++++++++
 Documentation/translations/index.rst          |   3 +
 .../translations/pt_BR/doc-guide/index.rst    |  19 +
 .../pt_BR/doc-guide/translations.rst          | 666 ++++++++++++++++++
 Documentation/translations/pt_BR/index.rst    |  11 +
 6 files changed, 1352 insertions(+)
 create mode 100644 Documentation/doc-guide/translations.rst
 create mode 100644 Documentation/translations/pt_BR/doc-guide/index.rst
 create mode 100644 Documentation/translations/pt_BR/doc-guide/translations.rst

-- 
2.56.1


             reply	other threads:[~2026-11-19  4:12 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-19  4:10 Daniel Pereira [this message]
2026-11-19  4:10 ` [PATCH v3 1/2] docs: doc-guide: add a guide for translators Daniel Pereira
2026-11-19  4:10 ` [PATCH v3 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=20261119041009.63651-1-danielmaraboo@gmail.com \
    --to=danielmaraboo@gmail.com \
    --cc=akiyks@gmail.com \
    --cc=alexs@kernel.org \
    --cc=carlos.bilbao@kernel.org \
    --cc=chenyou910331@gmail.com \
    --cc=corbet@lwn.net \
    --cc=dzm91@hust.edu.cn \
    --cc=federico.vaga@vaga.pv.it \
    --cc=jani.nikula@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=si.yanteng@linux.dev \
    --cc=skhan@linuxfoundation.org \
    --cc=wy@wyuan.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.