From: Tatjana Dehler <tdehler@suse.com>
Date: Tue, 3 Aug 2021 13:45:45 +0000 (+0200)
Subject: doc/dev: Dashboard translations release update
X-Git-Tag: v17.1.0~1171^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=84da5ca55f9bc2713d35ec2ed22f9e608f5027cc;p=ceph.git

doc/dev: Dashboard translations release update

Add a note on how to add a new release resource to transifex.

Signed-off-by: Tatjana Dehler <tdehler@suse.com>
---

diff --git a/doc/dev/developer_guide/dash-devel.rst b/doc/dev/developer_guide/dash-devel.rst
index 5c616ade37c94..b69943f5fd217 100644
--- a/doc/dev/developer_guide/dash-devel.rst
+++ b/doc/dev/developer_guide/dash-devel.rst
@@ -1033,6 +1033,31 @@ To create a transifex api token visit `<https://www.transifex.com/user/settings/
 After the command ran successfully, build the UI and check if everything is
 working as expected. You also might want to run the frontend tests.
 
+Add a new release resource to transifex
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In order to organize the translations, we create a
+`transifex resource <https://www.transifex.com/ceph/ceph-dashboard/content/>`_
+for every Ceph release. This means, once a new version has been released, the
+``src/pybind/mgr/dashboard/frontend/i18n.config.json`` needs to be updated on
+the release branch.
+
+Please replace::
+
+"resource": "Master:master"
+
+by::
+
+"resource": "<Release-name>:<release-name>"
+
+E.g. the resource definition for the pacific release::
+
+"resource": "Pacific:pacific"
+
+Note:
+  The first part of the resource definition (before the colon) needs to be
+  written with a capital letter.
+
 Suggestions
 ~~~~~~~~~~~