mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH v3 0/2] docs: add a guide for translators
@ 2026-11-19  4:10 Daniel Pereira
  2026-11-19  4:10 ` [PATCH v3 1/2] docs: doc-guide: " Daniel Pereira
  2026-11-19  4:10 ` [PATCH v3 2/2] docs: pt_BR: translate doc-guide/translations.rst Daniel Pereira
  0 siblings, 2 replies; 3+ messages in thread
From: Daniel Pereira @ 2026-11-19  4:10 UTC (permalink / raw)
  To: Jonathan Corbet
  Cc: Shuah Khan, Randy Dunlap, Alex Shi, Yanteng Si, Dongliang Mu,
	Chen-Yu Yeh, Weijie Yuan, Federico Vaga, Akira Yokosawa,
	Carlos Bilbao, Jani Nikula, linux-doc, linux-kernel,
	Daniel Pereira

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


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-11-19  4:12 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-11-19  4:10 [PATCH v3 0/2] docs: add a guide for translators Daniel Pereira
2026-11-19  4:10 ` [PATCH v3 1/2] docs: doc-guide: " Daniel Pereira
2026-11-19  4:10 ` [PATCH v3 2/2] docs: pt_BR: translate doc-guide/translations.rst Daniel Pereira

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®