Add how-to for translations
authorDominic Jäger <d.jaeger@proxmox.com>
Wed, 29 May 2019 09:36:52 +0000 (11:36 +0200)
committerThomas Lamprecht <t.lamprecht@proxmox.com>
Wed, 29 May 2019 10:16:13 +0000 (12:16 +0200)
Explain where to find the source code for translation and
how to work with it, especially encouraging contributions
of non-developers.

Signed-off-by: Dominic Jäger <d.jaeger@proxmox.com>
pve-intro.adoc
translation.adoc [new file with mode: 0644]

index 0ced310..e4a8d99 100644 (file)
@@ -242,4 +242,5 @@ integrated, and they can use the same storage and network features
 as virtual machines.
 
 include::howto-improve-pve-docs.adoc[]
+include::translation.adoc[]
 
diff --git a/translation.adoc b/translation.adoc
new file mode 100644 (file)
index 0000000..ff99296
--- /dev/null
@@ -0,0 +1,29 @@
+[[translation]]
+Translating {pve}
+-----------------
+ifdef::wiki[]
+:pve-toplevel:
+endif::wiki[]
+
+
+A lot of users speak a language other than English and we depend on contributions
+to make {pve} available to users all over the world.
+We are always happy to welcome new localizers and invite you to help shape
+{pve}.
+
+Our language files are available as https://git.proxmox.com/?p=proxmox-i18n.git[git repository].
+If you are familiar with git we would be glad to see your contribution according
+to our {webwiki-url}Developer_Documentation[Developer Documentation].
+
+Nonetheless, translating does not require special technical skills.
+You can get the language files without setting up a development environment
+https://git.proxmox.com/?p=proxmox-i18n.git;a=tree[here].
+Right click on the "raw" link of your language and choose "Save Link As...".
+Do not hesitate to send your translation directly to office(at)proxmox.com with
+your signed {webwiki-url}Developer_Documentation#Software_License_and_Copyright[contributor license agreement].
+
+We use https://www.gnu.org/software/gettext/[gettext] to translate {pve}.
+As a result, the actual translation task is to write a translation of the
+`msgid` into the `msgstr` below it.
+Tools like https://poedit.net/[Poedit] make this process more convenient,
+especially for contributors who are not programmers.