From 985566d8eb1be788e3108aeecffd6b81d3829d44 Mon Sep 17 00:00:00 2001 From: Cameron Perera Date: Wed, 13 Jul 2022 11:17:13 -0500 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20Create=20README=20?= =?UTF-8?q?for=20translations=20(#1182)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ✅ Closes: ICU-3872 Co-authored-by: Dharini Jeeva --- addons/core/translations/README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 addons/core/translations/README.md diff --git a/addons/core/translations/README.md b/addons/core/translations/README.md new file mode 100644 index 000000000..1eee0184b --- /dev/null +++ b/addons/core/translations/README.md @@ -0,0 +1,30 @@ +# Translations + +Translations are used to keep template, form, and component files free of raw strings and create a single source of truth for text used throughout the repository. + +Examples: + +`{{t 'states.' message.type}}` + +`{{t (concat "errors." this.messageCode ".description")}}` + +### Actions +Action translations are reserved for actions a user can trigger. + +### Errors +Translations that are for varying error titles and descriptions. + +### Form +Translations for label and description text required for form fields. + +### Notifications +Translations for notification messages. + +### Resources +Translations with direction relation to different resources (e.g. accout, org, host). + +### States +Translations for text related to different states data could be in (e.g. active, inactive, error). + +### Root Translations +Translations for titles, descriptions, and translations that do not fit into other translation files. \ No newline at end of file