From b8dc3b5c8ab826f926197cd3cd0a597cb43e0a52 Mon Sep 17 00:00:00 2001 From: Ernesto Puerta Date: Fri, 29 Mar 2019 18:07:20 +0100 Subject: [PATCH] mgr/dashboard: add wording section to hacking.rst Fixes: http://tracker.ceph.com/issues/37337 Signed-off-by: Ernesto Puerta --- src/pybind/mgr/dashboard/HACKING.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/src/pybind/mgr/dashboard/HACKING.rst b/src/pybind/mgr/dashboard/HACKING.rst index 4a0c18091c113..4cea7c543e438 100644 --- a/src/pybind/mgr/dashboard/HACKING.rst +++ b/src/pybind/mgr/dashboard/HACKING.rst @@ -236,6 +236,25 @@ Example: Some helper html text +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 +`_. +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 ~~~~~~~~~~~~~~~~~ -- 2.39.5