Merge branch 'master' of https://github.com/azerion/gamedock-sdk

docs/console/game/localization/locales/index.md

@@ -0,0 +1,17 @@
+# Locales
+This page shows the Available Locales that the system supports.
+It is presented in two lists, one for the **enabled locales** (Selected List) and the other one for all the **available locales** not yet enabled (Available Locales List)
+
+## Contents
+- [Enable Locale](#enable-locale)
+- [Disable Locale](#disable-locale)
+
+### Enable Locale
+1. Select the Locales (for multiselect press 'Shift' key for selecting several or 'Ctrl'/'Cmd' for picking one by one ) that you want to enable from the **Available Locales** List
+2. Press the go right ![go-right](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/go-right.png) button to move the chosen locales to the **Selected** List
+3. Press **Save** to reflect your changes
+
+### Disable Locale
+1. Select the Locales (for multiselect press 'Shift' key for selecting several or 'Ctrl'/'Cmd' for picking one by one ) that you want to enable from the **Selected** List
+2. Press the go left ![go-left](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/go-left.png) button to move the chosen locales to the **Available Locales** List
+3. Press **Save** to reflect your changes

docs/console/game/localization/localization_key/index.md

@@ -0,0 +1,36 @@
+# Localization Keys
+
+This page lists all localization keys for the selected game
+
+## Contents
+- [Table Listing](#table-listing)
+- [Create Localization Key](#create-localization-key)
+- [Edit Localization Key](#edit-localization-key)
+- [Show/Hide Localization Key](#showhide-localization-key)
+
+
+### Table Listing
+The Table lists the following data for each Localization Key that exists :
+- **Key** : Localization Key (which is unique)
+- **Description** : Localization Key Description field, that is optional
+- **Tags** : Different tags used for grouping keys and related
+
+### Create Localization Key
+To create a new Localization Key for a game:
+1. Click on button **Create Localization Key**
+2. On the popup, fill in **Key** field with a unique name 
+3. On the popup, optionally, fill in **Description** field with a meaningful description
+4. On the popup, fill in **Tags** field with one or more tags for better categorizing
+5. Press **Save** to reflect the changes
+
+### Edit Localization Key
+To edit an existing Localization Key for a game:
+1. On the row from the key you want to edit click the button **Edit Localization Key** ![pencil](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/pencil.png)
+2. You can edit the values for the Localization Key as explained on the Create Localization Key section
+
+### Show/Hide Localization Key
+Hiding a Localization Key will hide it on the list of Localization Values and is not served when the locale is published.
+
+To hide or show a Localization Key for a game:
+1. On the row from the key you want to show or hide click the button **Show Localization Key** ![eye-open](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/eye-open.png) or **Hide Localization Key** ![eye-close](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/eye-close.png) depending on the intention
+2. Confirm the action clicking **Ok** on the popup

docs/console/game/localization/localization_value/index.md

@@ -0,0 +1,50 @@
+# Localization Values
+This page shows the Localization Values for each Localization Key per Locale.
+You can select the Source Locale and the Target Locale to be displayed.
+You can edit the draft value for a particular key in a Locale and also accept that value to change its status
+
+
+## Contents
+- [Table Listing](#table-listing)
+- [Select Source/Target Locale](#select-sourcetarget-locale)
+- [Edit Localization Value](#edit-localization-value)
+- [Accept Localization Value](#accept-localization-value)
+- [Accept Several Localization Values](#accept-several-localization-values)
+
+
+### Table Listing
+This table lists the following data for each Localization Value that exists :
+- **Key** : Localization Key (which is unique)
+- **Source** : The **accepted value** from the selected **Source Locale** (This row will not be shown if the Source Locale and Target Locale are the same)
+- **Draft** : the **Draft value** for the selected **Target Locale**, if any
+- **Accepted** : The **Accepted value** for the selected **Target Locale**, if any
+
+You can filter the table clicking on the dropdown **filter** ![filter](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/filter.png) , to show only certain values depending on their status
+
+### Select Source/Target Locale
+In order to be able to change a particular Locale you'll need to select them properly on the locale dropdown selectors
+1. Select the Source Locale from the first Dropdown control at the top of the Table
+2. Select the Target Locale from the second Dropdown control at the top of the Table
+3. The Table will be rendered with the Localization Values based on the two Locales selected
+
+### Edit Localization Value
+1. At the right, on the action column, click **Edit localization value** ![pencil](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/pencil.png) button for the row to edit
+2. On the popup , details for the selected Localization Key will be displayed:
+	- Key 
+	- Accepted value for the Target Locale selected (if any)
+	- Draft Value an input field where the user can input the new value for the Draft of the Localization Value for the selected Key and Target Locale
+	- Max length field that indicates the maximum characters length for the Localization Value for that Target Locale
+3. Fill in Draft Value field and optionally Max Length field
+4. Press **Save** to reflect the changes
+
+### Accept Localization Value
+If you want to accept a draft value and mark it as accepted value:
+
+1. On the row where you want to accept the value, at the right, on the action column, click **Accept draft value** ![ok-circle](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/ok-circle.png)
+2. On the confirmation popup that appears press **Ok**.
+3. It will accept the value and it will remove the contents of draft value
+
+### Accept Several Localization Values
+1. Select, using the checkboxes on the left, the rows for each Locale you want to accept
+2. Click on the button **Accept selected** that appears on the top when selecting rows
+3. Click **Ok** on the confirmation modal that follows

docs/console/game/localization/non_configured_keys/index.md

@@ -0,0 +1,19 @@
+# Unconfigured Keys
+This page shows a list of keys requested by the game but are not configured or translated yet
+
+## Contents
+- [Table Listing](#table-listing)
+- [Create Unconfigured Key](#create-unconfigured-key)
+
+### Table Listing
+- **Key** : Localization Key requested by the game but not existing or translated
+- **Locale** : Locale code not having the key translated
+- **Potential matches** : List of existing keys that are similar to the one requested. It is displayed with a match percentage
+- **Date** : The date the unconfigured key was requested
+- **Count** : Number of requests for that key
+
+### Create Unconfigured Key
+To create an unconfigured key:
+1. Click on the **Add Key** button ![plus](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/plus.png)
+2. On the popup, fill in the mandatory fields for the new key
+3. Press **Save** to register the changes

docs/console/game/localization/overview/index.md

@@ -0,0 +1,67 @@
+# Localization Overview
+This page lists all enabled languages for a particular game. 
+Per language, the list contains: The game locale code for that language, 4 columns detailing the number of translations that are accepted, drafted, localized and not localized.
+Clicking on each cell will get you to the Localization Value listing for that pair of locales.
+Lastly a column showing if any change on translation that has been accepted is not published yet.
+
+There are two action buttons, one for publishing a locale, and another for showing information related to that published locale.
+
+A functionality for importing and exporting a locale translation, in CSV format, is also available.
+
+Selecting several rows will allow you to export and publish multiple locales at the same time
+
+## Contents
+- [View Translation Status](#view-translation-status)
+- [Publish a Locale](#publish-a-locale)
+- [Show Locale details](#show-locale-details)
+- [Import Locale](#import-locale)
+- [Export Locale](#export-locale)
+- [Publish several Locales](#publish-several-locales)
+- [Unpublished Changes](#unpublished-changes)
+
+
+### View Translation Status
+The data table renders the listing of the Localization Values per Locale as **badge links** ![badge-link](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/badge-link.png) .
+Clicking each link will show the Localization Values view for the row's Locale, filtered by the status clicked
+
+
+### Publish a Locale
+Publishing a Locale will make it ready for being retrieved by the game.
+To Publish a Language Locale:
+1. Click on the action button **Publish Locale** ![ok-circle](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/ok-circle.png) for the Locale to be published
+2. Click **Ok** on the confirmation modal that follows
+
+### Show Locale details
+1. Click on the action button **Info** ![info-sign](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/info-sign.png)
+2. A popup will show details for the Locale published including a link to the actual translation JSON file
+
+### Import Locale
+For importing a locale, you'll need to have the data in CSV file with the following format:
+**`localization_key, source_locale, target_locale, Description, String Length`**
+
+File example: 
+- row 0 : `localization_key, en_US, es_ES, Description, String Length`
+- row 1 :`ShopTitleText, Shop, Tienda, Title for the Shop, 25`
+- row 2 :`ShopCaptionText, Wonderful Shop, Maravillosa Tienda, Caption for the Shop Header Image, 50`
+- row 3 :`ShopButtonBuyText, Buy, Comprar, Buy button on the Shop, 25`
+- row 4 : etc...
+
+
+1. Click on the three vertical dots on the right top to reveal the **Import Localization** option and click it
+2. On the popup click **Select File** and select a .csv file
+3. If there's no error (shown on the popup), click on **upload** and the file will be imported. Please note that if the locale is not enabled, it will be enabled automatically
+4. You will need to refresh the page to view the changes on the table listing
+
+### Export Locale
+1. Select, using the checkboxes ![checkbox](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/checkbox.png) on the left, the rows for each Locale you want to export
+2. Click on the button **Export Selected Languages** that appears on the top when selecting rows
+3. Click **Ok** on the confirmation modal that follows
+4. A .ZIP file containing one or several .CSV files (one .CSV per Locale selected for exporting) will be prompted to download. 
+
+### Publish Several Locales
+1. Select, using the checkboxes ![checkbox](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/checkbox.png) on the left, the rows for each Locale you want to publish
+2. Click on the button **Publish selected** that appears on the top when selecting rows
+3. Click **Ok** on the confirmation modal that follows
+
+### Unpublished Changes
+In case a Locale has an accepted value that has been changed but it is not published, it will be reflected here with a warning icon ![warning-sign](https://github.com/azerion/gamedock-sdk/raw/master/docs/console/_images/warning-sign.png). It is recommended to publish the Locale in order to see these changes reflected on the localization.

docs/console/game/localization/usage_stats/index.md

@@ -0,0 +1,11 @@
+# Usage Stats
+This page shows Usage Statistics about the different Language Locales that are being served by Gamedock SDK for the selected Game
+
+## Contents
+- [Show Usage stats](show-usage-stats)
+
+### Show Usage Stats
+1. On the top right corner, select the Date Range that you want to be displayed
+2. On the left table, **Usage per locale**, the total number of requests per locale is displayed for each enabled locale
+3. On the rigth table, **Usages timeline**, the same information is displayed showing per day how often the locale is requested
+4. Note that you can hide or show each line clicking on each locale legend on top of the chart