[PATCH] Update zh-tw document index.rst (#1)

[PATCH] Update zh-tw document index.rst (#1)

[arthur.yueh]

From: ArthurYueh <ysde108@gmail.com>

Trying to make the `zh-tw` index.rst document more readable for users who use `zh-tw`
---
 Documentation/translations/zh_TW/index.rst | 43 +++++++++-------------
 1 file changed, 18 insertions(+), 25 deletions(-)

diff --git a/Documentation/translations/zh_TW/index.rst b/Documentation/translations/zh_TW/index.rst
index c02c4b528..5458dab82 100644
--- a/Documentation/translations/zh_TW/index.rst
+++ b/Documentation/translations/zh_TW/index.rst
@@ -14,22 +14,20 @@
 
 
 .. note::
-   內核文檔繁體中文版的翻譯工作正在進行中。如果您願意並且有時間參與這項工
-   作，歡迎提交補丁給胡皓文 <src.res@email.cn>。
+   linux核心文件繁體中文的翻譯工作正在進行中。如果您願意並且有時間參與這項工
+   作，歡迎提交修正給胡皓文 <src.res@email.cn>。
 
-許可證文檔
+許可證
 ----------
 
-下面的文檔介紹了Linux內核原始碼的許可證（GPLv2）、如何在原始碼樹中正確標記
-單個文件的許可證、以及指向完整許可證文本的連結。
+下面的文件介紹了Linux核心原始碼的許可證（GPLv2）、如何在原始碼的樹狀紀錄中，正確標記各個文件的許可證、以及完整的許可證內文的連結。
 
 Documentation/translations/zh_TW/process/license-rules.rst
 
-用戶文檔
+用戶相關文件
 --------
 
-下面的手冊是爲內核用戶編寫的——即那些試圖讓它在給定系統上以最佳方式工作的
-用戶。
+下列的使用說明文件是爲了那些「試著在特定系統，最佳化linux核心執行」的用戶所寫的
 
 .. toctree::
    :maxdepth: 2
@@ -40,31 +38,29 @@ TODOList:
 
 * kbuild/index
 
-固件相關文檔
+硬體相關文件
 ------------
 
-下列文檔描述了內核需要的平台固件相關信息。
+下列文件有linux核心對於不同平台的期待的資訊。
 
 TODOList:
 
 * firmware-guide/index
 * devicetree/index
 
-應用程式開發人員文檔
+應用程式開發者文件
 --------------------
 
-用戶空間API手冊涵蓋了描述應用程式開發人員可見內核接口方面的文檔。
+user-space API文件，整合了有關於linux應用程式開發者方面的核心介面。
 
 TODOlist:
 
 * userspace-api/index
 
-內核開發簡介
+linux核心開發簡介
 ------------
 
-這些手冊包含有關如何開發內核的整體信息。內核社區非常龐大，一年下來有數千名
-開發人員做出貢獻。與任何大型社區一樣，知道如何完成任務將使得更改合併的過程
-變得更加容易。
+這些使用說明全面的包含了關於如何開發linux核心的資訊。linux核心社群非常龐大，一年下來有數千名開發者做出貢獻。與其他大型社群一樣，知道一些事情是如何運作的，會使得你PR的合併過程變得更加容易。
 
 .. toctree::
    :maxdepth: 2
@@ -82,12 +78,10 @@ TODOList:
 * livepatch/index
 * rust/index
 
-內核API文檔
+linux核心API文件
 -----------
 
-以下手冊從內核開發人員的角度詳細介紹了特定的內核子系統是如何工作的。這裡的
-大部分信息都是直接從內核原始碼獲取的，並根據需要添加補充材料（或者至少是在
-我們設法添加的時候——可能不是所有的都是有需要的）。
+以下使用說明從linux核心開發者的角度，詳細介紹了特定的linux核心子系統是如何運作的。這裡的大部分資訊，都是直接從linux核心原始碼內取出來的，並根據需要添加補充說明。
 
 TODOList:
 
@@ -133,25 +127,24 @@ TODOList:
 * scheduler/index
 * mhi/index
 
-體系結構無關文檔
+與linux核心架構無關的文件
 ----------------
 
 TODOList:
 
 * asm-annotations
 
-特定體系結構文檔
+與特定linux核心架構相關的文件
 ----------------
 
 TODOList:
 
 * arch
 
-其他文檔
+其他文件
 --------
 
-有幾份未排序的文檔似乎不適合放在文檔的其他部分，或者可能需要進行一些調整和/或
-轉換爲reStructureText格式，也有可能太舊。
+有些未排序的文件似乎不適合放在文件的其他部分，或者可能需要進行一些調整，或轉換爲reStructureText格式，也有可能就是太舊了。
 
 TODOList:
 
-- 
2.31.1

Re: [PATCH] Update zh-tw document index.rst (#1)

[Akira Yokosawa]

[+CC: Hu Haowen]

Hello Arthur,
Welcome to kerneldoc!

I have a few comments WRT how to post patches in translations
and .rst in particular.  Please see inline comments below.

(Note: I don't read Chinese text.)

On Sat,  4 Sep 2021 12:06:00 +0800, arthur.yueh wrote:
> From: ArthurYueh <ysde108@gmail.com>
> 
> Trying to make the `zh-tw` index.rst document more readable for users who use `zh-tw`
> ---

You do need to add your Signed-off-by tag here.
Otherwise, the patch won't be accepted.

See: Documentation/translations/zh_TW/process/submitting-patches.rst
or Documentation/process/submitting-patches.rst

As you see in the guide, in this case, you need to send zh_TW patches to
Hu Haowen, who is the maintainer of zh_TW translations.

You can find the right people to send patches by scripts/get_maintainer.pl

At current docs-next of -doc tree,

   ./scripts/get_maintainer.pl Documentation/translations/zh_TW/index.rst

gives the following list:

Hu Haowen <src.res@email.cn> (maintainer:TRADITIONAL CHINESE DOCUMENTATION)
Jonathan Corbet <corbet@lwn.net> (maintainer:DOCUMENTATION)
Alexei Starovoitov <ast@kernel.org> (supporter:BPF (Safe dynamic programs and tools))
Daniel Borkmann <daniel@iogearbox.net> (supporter:BPF (Safe dynamic programs and tools))
Andrii Nakryiko <andrii@kernel.org> (supporter:BPF (Safe dynamic programs and tools))
Martin KaFai Lau <kafai@fb.com> (reviewer:BPF (Safe dynamic programs and tools))
Song Liu <songliubraving@fb.com> (reviewer:BPF (Safe dynamic programs and tools))
Yonghong Song <yhs@fb.com> (reviewer:BPF (Safe dynamic programs and tools))
John Fastabend <john.fastabend@gmail.com> (reviewer:BPF (Safe dynamic programs and tools))
KP Singh <kpsingh@kernel.org> (reviewer:BPF (Safe dynamic programs and tools))
linux-doc-tw-discuss@lists.sourceforge.net (open list:TRADITIONAL CHINESE DOCUMENTATION)
linux-doc@vger.kernel.org (open list:DOCUMENTATION)
linux-kernel@vger.kernel.org (open list)
netdev@vger.kernel.org (open list:BPF (Safe dynamic programs and tools))
bpf@vger.kernel.org (open list:BPF (Safe dynamic programs and tools))

For this particular patch, I don't think BPF is relevant. so,

Hu Haowen <src.res@email.cn> (maintainer:TRADITIONAL CHINESE DOCUMENTATION)
Jonathan Corbet <corbet@lwn.net> (maintainer:DOCUMENTATION)
linux-doc-tw-discuss@lists.sourceforge.net (open list:TRADITIONAL CHINESE DOCUMENTATION)
linux-doc@vger.kernel.org (open list:DOCUMENTATION)   -> you posted here
linux-kernel@vger.kernel.org (open list)

should suffice.

(Note: linux-doc-tw-discuss@lists.sourceforge.net is not an open list,
but moderated.  You can omit it if you'd like, or it might be a good idea
to subscribe it if you are willing to continue contributing to
zh_TW translations.)

>  Documentation/translations/zh_TW/index.rst | 43 +++++++++-------------
>  1 file changed, 18 insertions(+), 25 deletions(-)
> 
> diff --git a/Documentation/translations/zh_TW/index.rst b/Documentation/translations/zh_TW/index.rst
> index c02c4b528..5458dab82 100644
> --- a/Documentation/translations/zh_TW/index.rst
> +++ b/Documentation/translations/zh_TW/index.rst
> @@ -14,22 +14,20 @@
>  
>  
>  .. note::
> -   內核文檔繁體中文版的翻譯工作正在進行中。如果您願意並且有時間參與這項工
> -   作，歡迎提交補丁給胡皓文 <src.res@email.cn>。
> +   linux核心文件繁體中文的翻譯工作正在進行中。如果您願意並且有時間參與這項工
> +   作，歡迎提交修正給胡皓文 <src.res@email.cn>。
>  
> -許可證文檔
> +許可證
>  ----------
   ------

In reST text, these bars indicate a section title and they should have
the same length as the title, so they should be shortened as well.
(One Chinese character -> two bars)

>  
> -下面的文檔介紹了Linux內核原始碼的許可證（GPLv2）、如何在原始碼樹中正確標記
> -單個文件的許可證、以及指向完整許可證文本的連結。
> +下面的文件介紹了Linux核心原始碼的許可證（GPLv2）、如何在原始碼的樹狀紀錄中，正確標記各個文件的許可證、以及完整的許可證內文的連結。

Please fold lines around 80 column.

>  
>  Documentation/translations/zh_TW/process/license-rules.rst
>  
> -用戶文檔
> +用戶相關文件
>  --------
   ------------

Ditto. (In this case need to be lengthened.)

I leave other similar mismatches in your patch.
I look forward to seeing a v2 of this patch.

        Thanks, Akira
>  
[...]