docs: ✏️ Create README for translations (#1182)

✅ Closes: ICU-3872

Co-authored-by: Dharini Jeeva <dharini@hashicorp.com>
This commit is contained in:
Cameron PereraandDharini Jeeva authored and GitHub committed 2022-07-13 11:17:13 -05:00
1 parent 7234a3841a
commit 985566d8eb
1 file changed
+30
+30
View File
@@ -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.