From: Ernesto Puerta <epuertat@redhat.com>
Date: Fri, 29 Mar 2019 17:07:20 +0000 (+0100)
Subject: mgr/dashboard: add wording section to hacking.rst
X-Git-Tag: v14.2.1~42^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=d52f6c025e443d568f1be5d1e7b7712d997ba8dc;p=ceph.git

mgr/dashboard: add wording section to hacking.rst

Fixes: http://tracker.ceph.com/issues/37337
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
(cherry picked from commit b8dc3b5c8ab826f926197cd3cd0a597cb43e0a52)
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
---

diff --git a/src/pybind/mgr/dashboard/HACKING.rst b/src/pybind/mgr/dashboard/HACKING.rst
index 8c834784096f..0aef27459d04 100644
--- a/src/pybind/mgr/dashboard/HACKING.rst
+++ b/src/pybind/mgr/dashboard/HACKING.rst
@@ -230,6 +230,25 @@ Example:
       Some <strong>helper</strong> html text
     </cd-helper>
 
+Terminology and wording
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Instead of using the Ceph component names, the approach
+suggested is to use the logical/generic names (Block over RBD, Filesystem over
+CephFS, Object over RGW). Nevertheless, as Ceph-Dashboard cannot completely hide
+the Ceph internals, some Ceph-specific names might remain visible.
+
+Regarding the wording for action labels and other textual elements (form titles,
+buttons, etc.), the chosen approach is to follow `these guidelines
+<https://www.patternfly.org/styles/terminology-and-wording/#terminology-and-wording-for-action-labels>`_.
+As a rule of thumb, 'Create' and 'Delete' are the proper wording for most forms,
+instead of 'Add' and 'Remove', unless some already created item is either added
+or removed to/from a set of items (e.g.: 'Add permission' to a user vs. 'Create
+(new) permission').
+
+In order to enforce the use of this wording, a service ``ActionLabelsI18n`` has
+been created, which provides translated labels for use in UI elements.
+    
 Frontend branding
 ~~~~~~~~~~~~~~~~~