RHIDP-8635-1 - Comprehensive documentation for developers on adding localization support to custom plugins

Author: Gerry-Forde

assemblies/assembly-localization-in-rhdh.adoc

@@ -9,15 +9,15 @@ include::modules/customizing-the-appearance/proc-select-rhdh-language.adoc[level
 
 include::modules/customizing-the-appearance/con-language-persistence.adoc[leveloffset=+2]
 
-include::modules/customizing-the-appearance/proc-overriding-translations.adoc[leveloffset=+1]
-
 // include::modules/customizing-the-appearance/proc-enabling-localization-in-quickstarts.adoc[leveloffset=+1]
 
 // include::modules/customizing-the-appearance/proc-enabling-localization-in-sidebar-items.adoc[leveloffset=+1]
 
 //include::modules/customizing-the-appearance/proc-enabling-localization-in-floating-action-button.adoc[leveloffset=+1]
 
-== Localization support for custom plugins
+== Localization support for plugins
+
+include::modules/customizing-the-appearance/proc-overriding-translations.adoc[leveloffset=+2]
 
 include::modules/customizing-the-appearance/ref-best-practices-for-localization.adoc[leveloffset=+2]
 

modules/customizing-the-appearance/proc-overriding-translations.adoc

@@ -2,7 +2,14 @@
 
 [id="prov-overriding-translations_{context}"]
 = Overriding translations
-In {product-very-short} 1.8, English and French are the supported languages. You can implement translations for other languages by using a JSON file to override the existing translation strings, and by updating the `i18n` section of your `{my-app-config-file}` configuration file to include the JSON translation override file.
+//In {product-very-short} 1.8, English and French are enabled by default. You can implement translations for other languages by using a JSON file to override the existing translation strings, and by updating the `i18n` section of your `{my-app-config-file}` configuration file to include the JSON translation override file.
+
+//In {product-very-short} 1.8, English and French are enabled by default. You can implement translations for other languages by adding the language translation strings to a file that overrides the existing translation strings. You must also update the `i18n` section of your `{my-app-config-file}` configuration file to add the new `locale` and your translation override file.
+
+//In {product-very-short} 1.8, English and French are enabled by default. You can add a translation strings file to your {product-short} deployment that you can use to override the default translation strings, or to implement translations for other languages.
+
+In {product-very-short} 1.8, you can override plugin translation strings without modifying the plugin source code.
+
 
 .Prerequisites
 * You have enabled localization in your {product-very-short} application.
@@ -11,35 +18,34 @@ In {product-very-short} 1.8, English and French are the supported languages. You
 // This feature is not being included in 1.8
 // . In the top user menu, go to *Settings* > *General*.
 // . Click on the download link in the *Translations* panel to download the default English translation strings.
-. Create the JSON file containing all your translation as shown in the following example:
+. Create a translation stings file containing all your translation as shown in the following example:
 +
 [id=i18n-enable]
 .`allTranslations.json` fragment with translation string overrides
 [source,json]
 ----
 {
   "plugin.global-floating-action-button": {
+    "en": {
+      "fab.quay.label": "QUAY EN JSON",
+      "fab.rbac.label": "RBAC EN JSON",
+      "fab.rbac.tooltip": "RBAC EN tooltip JSON"
+    },
     "fr": {
       "fab.quay.label": "QUAY French JSON",
       "fab.quay.tooltip": "QUAY french tooltip JSON",
       "fab.rbac.label": "RBAC French JSON",
       "fab.rbac.tooltip": "RBAC french tooltip JSON"
-    },
-    "en": {
-      "fab.quay.label": "QUAY EN JSON",
-      "fab.rbac.label": "RBAC EN JSON",
-      "fab.rbac.tooltip": "RBAC EN tooltip JSON"
     }
   },
   "plugin.global-header": {
-    "fr": {
-      "applicationLauncher.developerHub": "Developer Hub French JSON"
-    },
     "en": {
       "applicationLauncher.developerHub": "Developer Hub EN JSON"
+    },
+    "fr": {
+      "applicationLauncher.developerHub": "Developer Hub French JSON"
     }
   }
-
 }
 ----
 . Log in to your cluster and create a config map for your translations override strings:
@@ -104,3 +110,17 @@ i18n:
     - /opt/app-root/src/translations/all-translations.json
 ----
 
+.Additional resources
+// * link:{customizing-book-link}#configuring-templates[Enabling floating button localization in {product-short}]
+// * link:{customizing-book-link}#configuring-templates[Enabling Quickstart localization in {product-short}]
+// * link:{customizing-book-link}#configuring-templates[Enabling sidebar menu items localization in {product-short}]
+
+{context}
+
+* xref:proc-enabling-localization-in-floating-action-button_configuring-a-floating-action-button[Enabling floating button localization in {product-short}]
+* xref:proc-enabling-localization-in-quickstarts_customizing-the-quickstarts[Enabling Quickstart localization in {product-short}]
+* xref:proc-enabling-localization-in-sidebar-menu-items_customizing-appearance[Enabling sidebar menu items localization in {product-short}]
+
+// * xref:proc-enabling-localization-in-floating-action-button_{context}[fggdsg]
+// * xref:proc-enabling-localization-in-quickstarts_{context}[fggdsg]
+// * xref:proc-enabling-localization-in-sidebar-menu-items_{context}[fggdsg]