[pve-devel] [PATCH pve-docs] translation: combine old and current wikis

[pve-devel] [PATCH pve-docs] translation: combine old and current wikis

[Dylan Whyte]

This takes all of the relevant information from
an old wiki site (https://pve.proxmox.com/wiki/Translations)
and merges it into the document that is used in generating the
admin guide and current wiki
(https://pve.proxmox.com/wiki/Translating_Proxmox_VE) entry.

Also contains some rewording for better readability.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---
 translation.adoc | 50 +++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 41 insertions(+), 9 deletions(-)

diff --git a/translation.adoc b/translation.adoc
index 2dc156b..fcb0f99 100644
--- a/translation.adoc
+++ b/translation.adoc
@@ -6,10 +6,10 @@ ifdef::wiki[]
 endif::wiki[]
 
 
-The {pve} user interface is in English by default. Thanks to contributions by
-the community, translations to other languages are available. We welcome help to
-add new languages, translate the newest features, and improve incomplete or
-inconsistent translations.
+The {pve} user interface is in English by default. However, thanks to the
+contributions of the community, translations to other languages are also available.
+We welcome any support in adding new languages, translating the latest features, and
+improving incomplete or inconsistent translations.
 
 The language files are available as a
 https://git.proxmox.com/?p=proxmox-i18n.git[git repository]. If you are familiar
@@ -17,14 +17,46 @@ with git, please contribute according to our
 {webwiki-url}Developer_Documentation[Developer Documentation].
 
 Even if you are not familiar with git, you can help with translating {pve}.
-Download the language files
-https://git.proxmox.com/?p=proxmox-i18n.git;a=tree[here]. Then choose the
-language you want to improve. Right click on the "raw" link of this language
-file, and select 'Save Link As...'. Make your changes to the file, and then
+To start, you can download the language files
+https://git.proxmox.com/?p=proxmox-i18n.git;a=tree[here]. Find the
+language you want to improve, then right click on the "raw" link of this language
+file and select 'Save Link As...'. Make your changes to the file, and then
 send your final translation directly to office(at)proxmox.com together with a
 signed
 {webwiki-url}Developer_Documentation#Software_License_and_Copyright[contributor license agreement].
 
 We use https://www.gnu.org/software/gettext/[gettext] for the management of the
 translation files. Tools like https://poedit.net/[Poedit] offer a nice user
-interface to edit the translation files.
+interface to edit the translation files, but you can use whatever editor you're
+comfortable with. No programming knowledge is required for translating.
+
+
+How to Translate
+~~~~~~~~~~~~~~~~
+
+After cloning the git repository, you can create a new translation by doing the
+following (replace <LANG> with the language ID):
+
+ # cd proxmox-i18n
+ # make init-<LANG>.po
+
+Or you can edit an existing translation, using the editor of your choice:
+
+ # poedit <LANG>.po
+
+The po file must be translated to a .js file by invoking the script located in
+the same directory:
+
+ # ./po2js.pl -t pve xx.po >pve-lang-xx.js
+
+IMPORTANT: For this to work, you need to have the following perl packages installed
+on your system. For Debian/Ubuntu:
+
+ # apt-get install perl liblocale-po-perl libjson-perl
+
+The resulting file 'pve-lang-xx.js' can then be copied to the directory
+'/usr/share/pve-i18n', on your proxmox server, in order to test it out.
+
+You can send the finished translation to the proxmox team at the address
+office(at)proxmox.com, along with a signed contributor licence agreement.
+See [[Developer Documentation]]
-- 
2.20.1

Re: [pve-devel] [PATCH pve-docs] translation: combine old and current wikis

[Thomas Lamprecht]

Please switch over your mails "To" address from the old <pve-devel@pve.proxmox.com>
to the new <pve-devel@lists.proxmox.com>

On 8/28/20 10:25 AM, Dylan Whyte wrote:
> This takes all of the relevant information from
> an old wiki site (https://pve.proxmox.com/wiki/Translations)
> and merges it into the document that is used in generating the
> admin guide and current wiki
> (https://pve.proxmox.com/wiki/Translating_Proxmox_VE) entry.
> 
> Also contains some rewording for better readability.
> 
> Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
> ---
>  translation.adoc | 50 +++++++++++++++++++++++++++++++++++++++---------
>  1 file changed, 41 insertions(+), 9 deletions(-)
> 
> diff --git a/translation.adoc b/translation.adoc
> index 2dc156b..fcb0f99 100644
> --- a/translation.adoc
> +++ b/translation.adoc
> @@ -6,10 +6,10 @@ ifdef::wiki[]
>  endif::wiki[]
>  
>  
> -The {pve} user interface is in English by default. Thanks to contributions by
> -the community, translations to other languages are available. We welcome help to
> -add new languages, translate the newest features, and improve incomplete or
> -inconsistent translations.
> +The {pve} user interface is in English by default. However, thanks to the
> +contributions of the community, translations to other languages are also available.
> +We welcome any support in adding new languages, translating the latest features, and
> +improving incomplete or inconsistent translations.
>  
>  The language files are available as a
>  https://git.proxmox.com/?p=proxmox-i18n.git[git repository]. If you are familiar
> @@ -17,14 +17,46 @@ with git, please contribute according to our
>  {webwiki-url}Developer_Documentation[Developer Documentation].
>  
>  Even if you are not familiar with git, you can help with translating {pve}.
> -Download the language files
> -https://git.proxmox.com/?p=proxmox-i18n.git;a=tree[here]. Then choose the
> -language you want to improve. Right click on the "raw" link of this language
> -file, and select 'Save Link As...'. Make your changes to the file, and then

why isn't the "How to Translate" heading here? I mean, the whole sections reads
a bit strange to me, maybe we want to group this in two how-to sections.
"How to Translate simple" and "How to Translate with git clone" (better titles
obviously needed ^^)

> +To start, you can download the language files
> +https://git.proxmox.com/?p=proxmox-i18n.git;a=tree[here]. Find the
> +language you want to improve, then right click on the "raw" link of this language
> +file and select 'Save Link As...'. Make your changes to the file, and then
>  send your final translation directly to office(at)proxmox.com together with a
>  signed
>  {webwiki-url}Developer_Documentation#Software_License_and_Copyright[contributor license agreement].
>  
>  We use https://www.gnu.org/software/gettext/[gettext] for the management of the
>  translation files. Tools like https://poedit.net/[Poedit] offer a nice user
> -interface to edit the translation files.
> +interface to edit the translation files, but you can use whatever editor you're
> +comfortable with. No programming knowledge is required for translating.
> +
> +
> +How to Translate
> +~~~~~~~~~~~~~~~~
> +
> +After cloning the git repository, you can create a new translation by doing the
> +following (replace <LANG> with the language ID):
> +
> + # cd proxmox-i18n
> + # make init-<LANG>.po
> +
> +Or you can edit an existing translation, using the editor of your choice:
> +
> + # poedit <LANG>.po
> +
> +The po file must be translated to a .js file by invoking the script located in
> +the same directory:
> +

This step is a bit confusing, it lacks a reason, i.e., something like
"If you want to try your changes, you can either build a deb package, or apply them manually by translating the po file to a .js..."

> + # ./po2js.pl -t pve xx.po >pve-lang-xx.js
> +
> +IMPORTANT: For this to work, you need to have the following perl packages installed
> +on your system. For Debian/Ubuntu:
> +
> + # apt-get install perl liblocale-po-perl libjson-perl
> +
> +The resulting file 'pve-lang-xx.js' can then be copied to the directory
> +'/usr/share/pve-i18n', on your proxmox server, in order to test it out.
> +
> +You can send the finished translation to the proxmox team at the address
> +office(at)proxmox.com, along with a signed contributor licence agreement.
> +See [[Developer Documentation]]
> 

Maybe add something like:
"Alternatively, if you have some developer experience you can send them also
as patch to the development mailing list."