From c34111b0fdec2217fd1bce0dcc9867dedf38d1d6 Mon Sep 17 00:00:00 2001
From: Eliot Berriot <contact@eliotberriot.com>
Date: Sat, 30 Jun 2018 12:39:21 +0200
Subject: [PATCH] See #161: added initial translating guidelines
---
CONTRIBUTING | 3 ++-
README.rst | 7 ++++++-
TRANSLATORS.rst | 28 ++++++++++++++++++++++++++++
docs/index.rst | 1 +
docs/translators.rst | 1 +
5 files changed, 38 insertions(+), 2 deletions(-)
create mode 100644 TRANSLATORS.rst
create mode 100644 docs/translators.rst
diff --git a/CONTRIBUTING b/CONTRIBUTING
index 24a3a78f..dffe99d7 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -289,8 +289,9 @@ Typical workflow for a contribution
Internationalization
--------------------
+We're using https://github.com/Polyconseil/vue-gettext to manage i18n in the project.
When working on the front-end, any end-user string should be translated
-using either ``<i18next path="yourstring">`` or the ``$t('yourstring')``
+using either ``<translate>yourstring</translate>`` or ``$gettext('yourstring')``
function.
Extraction is done by calling ``yarn run i18n-extract``, which
diff --git a/README.rst b/README.rst
index ef3998d1..6f9772ea 100644
--- a/README.rst
+++ b/README.rst
@@ -26,4 +26,9 @@ Contribute
----------
Contribution guidelines as well as development installation instructions
-are outlined in `CONTRIBUTING <CONTRIBUTING>`_
+are outlined in `CONTRIBUTING <CONTRIBUTING>`_.
+
+Translate
+^^^^^^^^^
+
+Translators willing to help can refer to `TRANSLATORS <TRANSLATORS>`_ for instructions.
diff --git a/TRANSLATORS.rst b/TRANSLATORS.rst
new file mode 100644
index 00000000..f2015099
--- /dev/null
+++ b/TRANSLATORS.rst
@@ -0,0 +1,28 @@
+Translating Funkwhale
+=====================
+
+Thank you for reading this! If you want to help translate Funkwhale,
+you found the proper place :)
+
+Translation is done via our own Weblate instance at https://translate.funkwhale.audio/projects/funkwhale/front/.
+
+You can signup/login using your Gitlab account (from https://code.eliotberriot.com).
+
+Translation workflow
+--------------------
+
+Once you're logged-in on the Weblate instance, you can suggest translations. Your suggestions will then be reviewer
+by the project maintainer or other translators to ensure consistency.
+
+Guidelines
+----------
+
+Respecting those guidelines is mandatory if you want your translation to be included:
+
+- Use gender-neutral language and wording
+
+Requesting a new language
+-------------------------
+
+If you'd like to see a new language in Funkwhale, please open an issue here:
+https://code.eliotberriot.com/funkwhale/funkwhale/issues
diff --git a/docs/index.rst b/docs/index.rst
index 7d200da5..b107739a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -23,6 +23,7 @@ Funkwhale is a self-hosted, modern free and open-source music server, heavily in
api
third-party
contributing
+ translators
changelog
Indices and tables
diff --git a/docs/translators.rst b/docs/translators.rst
new file mode 100644
index 00000000..6728e9ad
--- /dev/null
+++ b/docs/translators.rst
@@ -0,0 +1 @@
+.. include:: ../TRANSLATORS.rst
--
GitLab