diff --git a/CONTRIBUTING b/CONTRIBUTING index 24a3a78ff..dffe99d71 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 ```` or the ``$t('yourstring')`` +using either ``yourstring`` or ``$gettext('yourstring')`` function. Extraction is done by calling ``yarn run i18n-extract``, which diff --git a/README.rst b/README.rst index ef3998d11..6f9772ea6 100644 --- a/README.rst +++ b/README.rst @@ -26,4 +26,9 @@ Contribute ---------- Contribution guidelines as well as development installation instructions -are outlined in `CONTRIBUTING `_ +are outlined in `CONTRIBUTING `_. + +Translate +^^^^^^^^^ + +Translators willing to help can refer to `TRANSLATORS `_ for instructions. diff --git a/TRANSLATORS.rst b/TRANSLATORS.rst new file mode 100644 index 000000000..f20150995 --- /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 7d200da54..b107739ae 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 000000000..6728e9ad4 --- /dev/null +++ b/docs/translators.rst @@ -0,0 +1 @@ +.. include:: ../TRANSLATORS.rst