Add translation guide
authorChocobozzz <me@florianbigard.com>
Thu, 21 Jun 2018 12:07:53 +0000 (14:07 +0200)
committerChocobozzz <me@florianbigard.com>
Thu, 21 Jun 2018 12:07:53 +0000 (14:07 +0200)
.github/CONTRIBUTING.md
README.md
support/doc/translation.md [new file with mode: 0644]

index d4488a89aefc9aac2cb3903e9be79479206e6c2c..c70bc44e21ceba324f6497b5150e52c1c1049d19 100644 (file)
@@ -4,11 +4,17 @@ Interesting in contributing? Awesome!
 
 **Quick Links:**
 
+  * [Translate](#translate)
   * [Give your feedback](#give-your-feedback)
   * [Write documentation](#write-documentation)
   * [Develop](#develop)
 
 
+## Translate
+
+You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
+
+
 ## Give your feedback
 
 You don't need to know how to code to start contributing to PeerTube! Other
index bfa4f20640e19468d2d4624b4fd59082f42a9566..09ab9fdc1054eb2848eb2c2da8893b413283ad79 100644 (file)
--- a/README.md
+++ b/README.md
@@ -117,11 +117,11 @@ Peertube app for [YunoHost](https://yunohost.org). See [here](https://github.com
 
 See the [production guide](/support/doc/production.md).
 
-## Contributing/Test
+## Contribute/Translate/Test
 
 See the [contributing
 guide](/.github/CONTRIBUTING.md)
-to see how to test or contribute to PeerTube. Spoiler alert: you don't need to be a
+to see how to test or contribute to PeerTube (write documentation, translate, develop...). Spoiler alert: you don't need to be a
 coder to help!
 
 ## API REST documentation
diff --git a/support/doc/translation.md b/support/doc/translation.md
new file mode 100644 (file)
index 0000000..207eac9
--- /dev/null
@@ -0,0 +1,24 @@
+# Translation
+
+We use [Zanata](http://zanata.org/) as translation platform. 
+Please do not edit xml files directly from Git, you have to use Zanata!
+
+If you don't see your locale in the platform, please [create an issue](https://github.com/Chocobozzz/PeerTube/issues) so we add it!
+
+
+## How to
+
+ * Create an account: https://trad.framasoft.org/zanata/?dswid=-7191
+ * Join a language team: https://trad.framasoft.org/zanata/languages?dswid=-7191
+ * Go to the PeerTube page https://trad.framasoft.org/zanata/iteration/view/peertube/develop/languages/fr?dswid=-6462
+ * Choose the locale and begin to translate PeerTube!
+
+## Files
+
+There are 4 files:
+ * **angular**: contains client strings
+ * **player**: contains player strings
+ * **server**: contains server strings (language, licence...)
+ * **iso639**: contains iso639 (languages) strings used by PeerTube to describe the audio language of a particular video.
+ It's the reason why these strings should be translated too. There are many strings so do not hesitate to translate only main audio languages. 
\ No newline at end of file