Translation of kernel documentation

Translation of kernel documentation

[Matic Urbanija]

Hi, 

first of all, I'm terribly sorry if this isn't the right place to ask about translation. I sent an email to helpdesk but so far no answer from them.

My name is Matic Urbanija, I am a teacher at Vegova - Upper Secondary School of Electrical and Computer Engineering and Technical Gymnasium Ljubljana, Slovenia (https://www.vegova.si/about-us-vegova/). 

I would like to translate kernel documentation into Slovenian language. Maybe some of my students would also like to participate.

Are there some special requirements or procedures which have to be fulfilled before starting translation project? What is the proper or recommend way to start to translate the kernel documentation?

Best regards,

Matic Urbanija

Re: Translation of kernel documentation

[Matthew Wilcox]

On Fri, Jun 07, 2024 at 05:45:10PM +0000, Matic Urbanija wrote:
> Hi, 
> 
> first of all, I'm terribly sorry if this isn't the right place to ask about translation. I sent an email to helpdesk but so far no answer from them.

This is the right place!

> My name is Matic Urbanija, I am a teacher at Vegova - Upper Secondary School of Electrical and Computer Engineering and Technical Gymnasium Ljubljana, Slovenia (https://www.vegova.si/about-us-vegova/). 
> 
> I would like to translate kernel documentation into Slovenian language. Maybe some of my students would also like to participate.
> 
> Are there some special requirements or procedures which have to be fulfilled before starting translation project? What is the proper or recommend way to start to translate the kernel documentation?

Start by creating Documentation/translations/sl/ (the iso639 code for Slovenian)
Add an entry to Documentation/translations/index.rst
Add Documentation/translations/sl/index.rst

Now start adding documents ;-)

You can send patches to this mailing list for Jon to apply to the
documentation tree for merging.

Re: Translation of kernel documentation

[Carlos Bilbao]

Hello Matic,

On 6/7/24 14:11, Matthew Wilcox wrote:
> On Fri, Jun 07, 2024 at 05:45:10PM +0000, Matic Urbanija wrote:
>> Hi, 
>>
>> first of all, I'm terribly sorry if this isn't the right place to ask about translation. I sent an email to helpdesk but so far no answer from them.
> This is the right place!
>
>> My name is Matic Urbanija, I am a teacher at Vegova - Upper Secondary School of Electrical and Computer Engineering and Technical Gymnasium Ljubljana, Slovenia (https://www.vegova.si/about-us-vegova/). 
>>
>> I would like to translate kernel documentation into Slovenian language. Maybe some of my students would also like to participate.
>>
>> Are there some special requirements or procedures which have to be fulfilled before starting translation project? What is the proper or recommend way to start to translate the kernel documentation?
> Start by creating Documentation/translations/sl/ (the iso639 code for Slovenian)
> Add an entry to Documentation/translations/index.rst
> Add Documentation/translations/sl/index.rst


Your first commit will probably resemble this:
https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/?h=next-20240607&id=444064185df7c4b0f7bb41e25b1bb197a1e4a918
but, please, don't add yourself to MAINTAINERS if you aren't willing to review
future contributions (maintaining).
This is a fantastic way to introduce your students to the kernel
contribution process. Note they should at least have a basic understanding
of operating systems and low-level languages (mostly C) to translate
effectively.
Feel free to add my email in CC in future communications so I can help.


>
> Now start adding documents ;-)
>
> You can send patches to this mailing list for Jon to apply to the
> documentation tree for merging.
>

Thanks,
Carlos

Re: Translation of kernel documentation

[Carlos Bilbao]

On 6/10/24 13:44, Carlos Bilbao wrote:

> Hello Matic,
>
> On 6/7/24 14:11, Matthew Wilcox wrote:
>> On Fri, Jun 07, 2024 at 05:45:10PM +0000, Matic Urbanija wrote:
>>> Hi, 
>>>
>>> first of all, I'm terribly sorry if this isn't the right place to ask about translation. I sent an email to helpdesk but so far no answer from them.
>> This is the right place!
>>
>>> My name is Matic Urbanija, I am a teacher at Vegova - Upper Secondary School of Electrical and Computer Engineering and Technical Gymnasium Ljubljana, Slovenia (https://www.vegova.si/about-us-vegova/). 
>>>
>>> I would like to translate kernel documentation into Slovenian language. Maybe some of my students would also like to participate.
>>>
>>> Are there some special requirements or procedures which have to be fulfilled before starting translation project? What is the proper or recommend way to start to translate the kernel documentation?
>> Start by creating Documentation/translations/sl/ (the iso639 code for Slovenian)
>> Add an entry to Documentation/translations/index.rst
>> Add Documentation/translations/sl/index.rst
>
> Your first commit will probably resemble this:
> https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/?h=next-20240607&id=444064185df7c4b0f7bb41e25b1bb197a1e4a918
> but, please, don't add yourself to MAINTAINERS if you aren't willing to review
> future contributions (maintaining).
> This is a fantastic way to introduce your students to the kernel
> contribution process. Note they should at least have a basic understanding
> of operating systems and low-level languages (mostly C) to translate
> effectively.
> Feel free to add my email in CC in future communications so I can help.
>

By the way, next time you probably want to CC linux-kernel@vger.kernel.org
so we can easily search for this thread (e.g., in lkml.org).


>> Now start adding documents ;-)
>>
>> You can send patches to this mailing list for Jon to apply to the
>> documentation tree for merging.
>>
> Thanks,
> Carlos


Thanks,
Carlos

>

Re: Translation of kernel documentation

[Jonathan Corbet]

Matic Urbanija <maticurbanija@protonmail.com> writes:

> first of all, I'm terribly sorry if this isn't the right place to ask
> about translation. I sent an email to helpdesk but so far no answer
> from them.

As has already been said, this is the right place.

Out of curiosity, which "helpdesk" did you send email to?

> My name is Matic Urbanija, I am a teacher at Vegova - Upper Secondary
> School of Electrical and Computer Engineering and Technical Gymnasium
> Ljubljana, Slovenia (https://www.vegova.si/about-us-vegova/).
>
> I would like to translate kernel documentation into Slovenian
> language. Maybe some of my students would also like to participate.
>
> Are there some special requirements or procedures which have to be
> fulfilled before starting translation project? What is the proper or
> recommend way to start to translate the kernel documentation?

Best is to look at how the other languages are handled.  I would
recommend starting with the stuff in Documentation/process/ as being of
the most general interest.

If you can recruit somebody else to help with review of translation
patches, that would be most helpful.  On my own, I'm not qualified to
know what's a good translation and what isn't.

I do have to ask one question: is it your intent to maintain this
translation once it has gone upstream?  Documentation evolves over time;
having a bunch of out-of-date translations in the tree is not
particularly useful.  I'll be a lot happier about accepting a new
translation if I have some assurance that it will not end up in that
state.

Thanks,

jon

Re: Translation of kernel documentation

[Jonathan Corbet]

Carlos Bilbao <carlos.bilbao.osdev@gmail.com> writes:

> By the way, next time you probably want to CC linux-kernel@vger.kernel.org
> so we can easily search for this thread (e.g., in lkml.org).

Copying linux-kernel is fine, but https://lore.kernel.org/all/ is your
friend when trying to find patches submitted to any list.

jon

Re: Translation of kernel documentation

[Matic Urbanija]

Hi!

Thank you all for your advice.

I'll start with Documentation/process, as Jonathan suggested. After 
that doc-guide and translations, especially Chinese (I read
Chinese) and Japanese (currently learning Japanese).

(Are there any other documents that I should read?)

I think this will be enough reading until the beginning of September
when new school year starts.

I talked with one of our English teachers today and she was very
enthusiastic about my plan to involve our students in the translation
of a kernel documentation.

Of course, I intend to maintain Slovenian translation.

The helpdesk was helpdesk@kernel.org 

Best regards,

Matic Urbanija

---------------------------------------------------------------
From: Jonathan Corbet <corbet@lwn.net>
To: Matic Urbanija <maticurbanija@protonmail.com>,
	"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>


Matic Urbanija <maticurbanija@protonmail.com> writes:

> first of all, I'm terribly sorry if this isn't the right place to ask
> about translation. I sent an email to helpdesk but so far no answer
> from them.
As has already been said, this is the right place.

Out of curiosity, which "helpdesk" did you send email to?

> My name is Matic Urbanija, I am a teacher at Vegova - Upper Secondary
> School of Electrical and Computer Engineering and Technical Gymnasium
> Ljubljana, Slovenia (https://www.vegova.si/about-us-vegova/).
>
> I would like to translate kernel documentation into Slovenian
> language. Maybe some of my students would also like to participate.
>
> Are there some special requirements or procedures which have to be
> fulfilled before starting translation project? What is the proper or
> recommend way to start to translate the kernel documentation?
Best is to look at how the other languages are handled.  I would
recommend starting with the stuff in Documentation/process/ as being of
the most general interest.

If you can recruit somebody else to help with review of translation
patches, that would be most helpful.  On my own, I'm not qualified to
know what's a good translation and what isn't.

I do have to ask one question: is it your intent to maintain this
translation once it has gone upstream?  Documentation evolves over time;
having a bunch of out-of-date translations in the tree is not
particularly useful.  I'll be a lot happier about accepting a new
translation if I have some assurance that it will not end up in that
state.

Thanks,

jon

Re: Translation of kernel documentation

[Jonathan Corbet]

Matic Urbanija <maticurbanija@protonmail.com> writes:

> Hi!
>
> Thank you all for your advice.
>
> I'll start with Documentation/process, as Jonathan suggested. After 
> that doc-guide and translations, especially Chinese (I read
> Chinese) and Japanese (currently learning Japanese).
>
> (Are there any other documents that I should read?)

I would strongly recommend perusing the other process documents,
starting with submitting-patches.rst.  Spending some time reading the
mailing lists to get a sense for how email communication works in this
community (no top-posting, for example) would also be helpful.

Please CC me on any documentation patches.

Thanks,

jon

Re: Translation of kernel documentation

[Matic Urbanija]

-------- オリジナルメッセージ --------
2024/06/17 16:25、Jonathan Corbet <corbet@lwn.net> 書きました：

>  Matic Urbanija <maticurbanija@protonmail.com> writes:
>  
>  > Hi!
>  >
>  > Thank you all for your advice.
>  >
>  > I'll start with Documentation/process, as Jonathan suggested. After
>  > that doc-guide and translations, especially Chinese (I read
>  > Chinese) and Japanese (currently learning Japanese).
>  >
>  > (Are there any other documents that I should read?)
>  
>  I would strongly recommend perusing the other process documents,
>  starting with submitting-patches.rst.  Spending some time reading the
>  mailing lists to get a sense for how email communication works in this
>  community (no top-posting, for example) would also be helpful.

Sorry for top-posting.

I'll start with submitting-patches.rst.
>  
>  Please CC me on any documentation patches.
>  
>  Thanks,
>  
>  jon
>  

Ok.
Thanks.

Best regards,

Matic Urbanija