Merge pull request #19 from LitaaFlo/update-gui-docs

Changes for gui's description

docs/dev-portal/gui/configs-management.md

@@ -2,9 +2,9 @@
 title: Configs Management
 ---
 
-# Config Management  
+# Config Management
 
-Config Management – the general tab for working with game services configs.  
+Config Management – the general tab for working with game services configs.
 
 ![Config Managment Tab](./images/config-management.png)
 
@@ -19,65 +19,119 @@ There are different types of configs:
 * Unlocks      [(see format)](../configs-format/unlocks-config-format.md)
 * Modes        [(see format)](../configs-format/modes-config-format.md)
 * Tables       [(see format)](../configs-format/tables-config-format.md)
+* Triggers
+* Items
 
 [Single configs](#single-config):
 * Contacts     [(see format)](../configs-format/contacts-config-format.md)
+* Externals
 
 [Scripts configs](#scripts-config):
 * Scripts      [(see format)](../configs-format/profile-config-format.md)
 
 ### Multi-element config
-Multi-element config contains array of similar elements, like stat, unlock, table, etc. All multi-element configs are editing in one way.  
+Multi-element config contains array of similar elements, like stat, unlock, table, etc. All multi-element configs are editing in one way.
 Consider stat config editing:
 
 #### Adding new config element
-For adding new config element, click button with “Add” text. After click a new config element will be added.  
+For adding new config element, click button with “Add” text. After click a new config element will be added.
 New config element automatically filled with default parameters.
 ![Add element](./images/add-element.png)
-You need to fill the name field and press save button. Also you can change another fields.  
+You need to fill the name field and press save button. Also you can change another fields.
 ![Add element](./images/add-element_save.png)
 :::caution
-The changes aren't saved until Save button not pressed. If page reload all unsaved changes will be missed.  
+The changes aren't saved until Save button not pressed. If page reload all unsaved changes will be missed.
 :::
 
 #### Deleting element
-To delete config element, click Remove button. Then you must confirm your action in the modal window.  
+To delete config element, click Remove button. Then you must confirm your action in the modal window.
 ![Remove element](./images/remove-element.png)
 
 #### Editing element
-To edit config element, use [Code Editor](#code-editor).  
+To edit config element, use [Code Editor](#code-editor).
 ![Edit element](./images/edit-element.png)
-To open Code Editor for Config element, click to arrow in the Code Editor column.  
+To open Code Editor for Config element, click to arrow in the Code Editor column.
 ![Edit element open](./images/edit-element-open.png)
-Data are edited as in a regular text editor, with [code-complete](#code-complete), [errors marker](#errors-marker) and [changes marker](#changes-marker)  
+Data are edited as in a regular text editor, with [code-complete](#code-complete), [errors marker](#errors-marker) and [changes marker](#changes-marker)
+
+#### Common actions for config elements
+You can change some config elements and save it by the click to button “Save all”
+![Save all elements](./images/save-all-elements.png)
+To edit the common values ​​of several config elements, select them by checking the appropriate checkboxes
+![Check elements](./images/check-elements.png)
+Click on the “Change selected” button. In the window that opens, edit the necessary values.
+![Change values for checked rows](./images/change-values-for-checked-rows.png)
+To remove a config parameter, use the parameter with value `null`
+![Delete values for checked rows](./images/delete-values-for-checked-rows.png)
+To delete selected elements click to button “Delete selected”
+![Delete selected](./images/delete-selected.png)
+You can upload config from file and download to file with buttons “Upload config” and “Download config”
+![Upload and download config](./images/upload-downoad-config.png)
+
+#### Filters
+To open the string input for filtering, click the button with the filter icon.
+![Open filter button](./images/open-filter-button.png)
+Filters available values:
+Equality/inequality - matches records where value of the field is equal/unequal to specified value, ex.: `foo=42, foo!=-3.14, foo!="a string", foo=true, foo=false`
+Regex - if field value is a string, matches it against specified regex, ex.: `foo=/^https?:\/\// foo=/^https?:\/\//`
+Comparison `(<, >, <=, >=)` - if field value is a number, compares it with specified value, ex.: `foo>42, foo<=-3.14`
+Presence - matches records where specified field is present/missing, ex.: `foo exists, foo !exists`
+Array - matches records where the value of a field equals to any value in the array, ex.: `foo in [42, -3.14, "bar", true, false]`
+Complex queries can be constructed using logical AND (&) and OR (|) operators, ex.: `foo=42&bar exists`
+Filters can be grouped by parenthesis, ex.: `foo=42&(bar exists|foo<100)`
+Operator precedence (from highest to lowest): `(), &, |`
+Spaces may be omited where possible: `foo = 42 & bar in [1, 2, 3] | baz exists` is equivalent to `foo=42&bar in[1,2,3]|baz exists`
+Array may have trailing comma: `[1, 2, 3,]` is equivalent to `[1, 2, 3]`
+To search by date, use the timestamp format `create_t=1708437468`
+
+You always can use clue to watch filters available values
+![Open filter clue](./images/open-filter-clue.png)
+To filter by dates you need to use timestamp format. To get date in timestamp format click to button into configs row beside data value.
+![Copy timestamp button](./images/copy-timestamp-button.png)
+The date in timestamp format will be copy to clipboard and you can use it in filters.
+
+#### Namespaces tabs
+List of enable tabs with namespace is shown on the top of the config's page.
+![Namespaces tabs](./images/namespaces-tabs.png)
+To show elements matching the needed namespace click to the tab.
+To add a new config tab - click of the button “Add namespace”. Input unique name for a new tab and click to the “Ok” button:
+![Add namespace](./images/add-namespace.png)
+You can delete new tabs, before they are not contained elements.
+![Delete namespace](./images/delete-namespace.png)
+To change the namespace for some config element change field "namespace" in the Code Editor and save changes
+![Change namespace](./images/change-namespace.png)
+The element will show in the correct tab:
+![Change namespace success](./images/change-namespace-success.png)
 
 ### Single config
-Single config is a json object which may contains fields with different type.  
+Single config is a json object which may contains fields with different type.
 To edit single config use [Code Editor](#code-editor).
 ![Single config edit](./images/single-edit.png)
-Data are edited as in a regular text editor, with [code-complete](#code-complete), [errors marker](#errors-marker) and [changes marker](#changes-marker)  
+Data are edited as in a regular text editor, with [code-complete](#code-complete), [errors marker](#errors-marker) and [changes marker](#changes-marker)
 
 ### Scripts config
 Profile server use scripts configs on [daScript](https://dascript.org/) language.
 More information about [script config format](../configs-format/profile-config-format.md).
 
 #### Upload/Download scripts archive
-To upload scripts use zip archive containing folder with scripts.  
-You must create zip archive by you self and than upload it using `Upload Zip` button.  
-You can download scripts zip archive using `Download Zip` button.  
+To upload scripts use zip archive containing folder with scripts.
+You must create zip archive by you self and than upload it using “Upload Zip” button.
+You can download scripts zip archive using “Download Zip” button.
+You can upload configs from the directory using the “Upload from directory” button
 ![Upload scripts](./images/scripts.png)
+Below the buttons the downloaded files are displayed in the form of a tree.
 
 ### Code Editor
 #### Code Complete
-Code completion allows complete all fields for config element or prompts the possible values.  
-To initiate code compleate press `Ctrl+Space`  
+Code completion allows complete all fields for config element or prompts the possible values.
+To initiate code compleate press `Ctrl+Space`
 Field name code complete:
 ![Code complete](./images/code-complete-field.png)
 Value code complete:
 ![Code complete](./images/code-complete-value.png)
 
 #### Errors marker
-If Configs editor contains errors the Save button is disabled. Line with error marked with a red circle.  
+If Configs editor contains errors the Save button is disabled. Line with error marked with a red circle.
 To read the error message move mouse arrow over the red circle.
 ![Mark error](./images/mark-error.png)
 
@@ -88,67 +142,83 @@ Changed parameters marked with a special symbol (pencil) for simpler tracking ch
 ## Deploy configs
 To deploy configs to the services use Deploy menu item.
 
-![Deploy](./images/deploy.png)  
+![Deploy](./images/deploy.png)
 
 The deploy window has 2 tabs:
 * Tags List
 * Compare
+* History
 
 ### Tags List
 Еag list tab provides an interface for working with tags: adding tags, uploading configs from tag, exporting data from tag, etc.
-![Tag list](./images/tag-list-tab.png)  
+![Tag list](./images/tag-list-tab.png)
 
-#### Fast deploy configs
-The easiest way to deploy configs to services is `Fast update`.  
-![Fast deploy](./images/fast-deploy.png)  
-This will directly upload current configs to services, just like from a master in git.  
-Fast update automatically create special tag `_fast`. This tag rewrite each time you use `Fast update`.  
-![Fast deploy](./images/fast-deploy-tag.png)  
-
-'Fast update' is useful on test circuit, but this is not good idea for production.  
-The best way - save the configs in a tag first, as add git tag. And then deploy to services from tag.  
-In the future, you can reuse this tag, for deploy or restore configs from it.  
-
-#### Add new tag
-To add new tag from current configs press `Add tag`.  
+#### Add new tag or update tag
+To add new tag or update tag press “Add/Update tag”.
 :::note
-Tag name must be unique.
+Tag name must be unique. If name isn't unique the tag will be overwriting.
 :::
-![Add tag](./images/add-tag.png)  
+![Add tag](./images/add-tag.png)
+You can use current configs or import tag from data for fill tags.
+![Current configs or import from tag](./images/current-configs-import-from-tag.png)
 
-#### Deploy configs from tag
-To deploy configs from tag click `Update configs` button and than confirm deploy:  
-![Deploy tag](./images/deploy-tag.png)  
-You can see updates progress information after launching the update for any configs:  
-![Deploy progress](./images/deploy-progress.png)  
-Last deployed tag shows in the top of the table:  
-![Last deployed tag](./images/last-deployed-tag.png)  
+#### Validate tag
+To validate tag click to “Validate” button
+![Validate tag](./images/validate-tag.png)
+You can validate all tag by one button “Valid all”
+![Valid all](./images/valid-all-button.png)
 
-#### Import tag
-Also you can import configs, press `Import tag` button. Set the tag name and paste configs text to the modal window:  
-![Import tag data](./images/import-tag.png)  
+
+#### Deploy configs from tag
+To deploy configs from tag click “Deploy” button and than confirm deploy:
+![Deploy tag](./images/deploy-tag.png)
+:::note
+Deploy button becomes enable after validation and if result of validation is Valid.
+:::
+You can see updates progress information after launching the update for any configs:
+![Deploy progress](./images/deploy-progress.png)
+Last deployed tag shows in the top of the table:
+![Last deployed tag](./images/last-deployed-tag.png)
 
 #### Copy configs to buffer
-To get configs from tag use `Copy to buffer` button:  
-![Copy to buffer](./images/copy-tag-to-buffer.png)  
-Also you can copy to buffer current configs:  
-![Copy current to buffer](./images/copy-current-to-buffer.png)  
+To get configs from tag use “Copy to buffer” button:
+![Copy to buffer](./images/copy-tag-to-buffer.png)
+Also you can copy to buffer current configs:
+![Copy current to buffer](./images/copy-current-to-buffer.png)
 This is useful to transferring tags between different game environments(test, staging, production) or between different game.
 
 #### Restore configs from tag
-You can replace all current configs to configs from tag, just press 'Restore configs` button:  
-![Restore tag](./images/restore-tag.png)  
+You can replace all current configs to configs from tag, just press 'Restore configs` button:
+![Restore tag](./images/restore-tag.png)
 
 #### View tag configs
-Click to arrow button to display tag configs:  
-![View tag](./images/view-tag.png)  
-
+Click to arrow button to display tag configs:
+![View tag](./images/view-tag.png)
+
+#### Delete tag
+To delete tag click to button
+![Delete tag](./images/delete-tag.png)
+You can delete some selected tags with button “Delete selected”
+![Delete selected tags](./images/delete-selected-tags.png)
+
+#### Filters
+To open the string input for filtering, click the button with the filter icon.
+![Tags filters](./images/tags-filters.png)
+More information about [filters](../gui/configs-management#filters).
+
 ### Compare
-Select "Compare" tab to view diff between 2 tags:  
-![Compare tab](./images/compare-tab.png)  
-Choose Before and After tags:  
-![Compare tags](./images/compare-tags.png)  
-You can see the difference in this section after clicking on the block with changing:  
-![Tags diff](./images/tags-diff.png)  
-A large number of equal lines are hidden in differentials. If you want to see more equal rows, select the value in the context selection:  
-![Tags diff rows](./images/tags-diff-rows.png)  
+Select "Compare" tab to view diff between 2 tags:
+![Compare tab](./images/compare-tab.png)
+Choose Before and After tags:
+![Compare tags](./images/compare-tags.png)
+You can see the difference in this section after clicking on the block with changing:
+![Tags diff](./images/tags-diff.png)
+A large number of equal lines are hidden in differentials. If you want to see more equal rows, select the value in the context selection:
+![Tags diff rows](./images/tags-diff-rows.png)
+
+### History
+Select "History" tab to view deploy history:
+![History tab](./images/history-tab.png)
+You can filter deploy history by tag names or time (from time/to time) or open the string input for filtering, click the button with the filter icon.
+![History tab filter](./images/history-tab-filter.png)
+More information about [filters](../gui/configs-management#filters).

docs/dev-portal/gui/leaderboard.md

@@ -32,3 +32,16 @@ To sorting the Leaderboard by various stat just click on column header:
 
 Use the navigation buttons to move to the next or previous page of the Leaderboard:
 ![Leaderboard pages](./images/lb-pages.png)
+
+You can save leaderboard table with filters. The table is saving when you click to “Get Leaderboard” button. To show all saved tables and filters open tabs.
+![Leaderboard tabs](./images/lb-tabs.png)
+
+To add new leaderboard item click to “Add leaderboard item”.
+![Add leaderboard tab](./images/lb-add-tab.png)
+
+To remove saved leaderboard item click to remove button.
+![Remove leaderboard tab](./images/lb-remove-tab.png)
+:::note
+You can't remove last item in the list
+:::
+

docs/dev-portal/gui/user-management.md

@@ -2,36 +2,54 @@
 title: User management
 ---
 
-# User profile management  
-To see a user management info select appropriate menu item:  
+# User profile management
+To see a user management info select appropriate menu item:
 ![User management](./images/user-management.png)
 
 Input the userid at the field and press `View user profile` button:
 ![User data](./images/choose-user-data.png)
 
-In User management window you can see:
+In User management window you can see sections with:
 * User data
 * Admin actions
 
 ![User data](./images/user-data.png)
 
+You can change width for actions block and data block with separator line:
+![Admin actions change width](./images/admin-actions-change-size.png)
+
+To select blocks to reload after sending actions use select block:
+![Admin actions select sections to reload](./images/admin-actions-select-sections-to-reload.png)
+
 ## User data
-User data is presented as tree-view, and splitted by services(userstat, profile, contacts, etc.)  
+User data is presented as tree-view, and splitted by services(userstat, profile, contacts, etc.)
 ![Userstat data](./images/userstat-user-data.png)
 
-To copy any tree node value - click to `Copy Icon` next to the value:  
+To reload user data and admin actions inside section click to Reload button.
+![Userstat data reload](./images/userstat-user-data-reload.png)
+
+To copy any tree node value - click to `Copy Icon` next to the value:
 ![Value copy](./images/user-info-value-copy.png)
 
 ## Admin actions
-Admin actions also splitted by services(userstat, profile, etc.)  
-
+There are relevant admin actions inside each services(userstat, profile, etc.)
 ![Admin actions](./images/admin-actions.png)
+
 #### Profile admin actions
-To use profile actions in admin panel you must add `admin_panel` tag in [action declaration on daScript](../configs-format/profile-config-format.md).  
-To use action set action parameters and press `Send action` button:  
-![Admin actions](./images/send-admin-actions.png)  
-You can see action result in the console:  
-![Admin actions](./images/admin-actions-result.png)
+To use profile actions in admin panel you must add `admin_panel` tag in [action declaration on daScript](../configs-format/profile-config-format.md).
+To use action set action parameters and press `Send action` button:
+![Admin actions](./images/send-admin-actions.png)
+
+You can see action result in the console:
+![Admin actions result](./images/admin-actions-result.png)
+
+#### Watched values block
+To add value to watched block click to the icon next to the value:
+![Admin actions add to watched block](./images/admin-actions-add-to-watched-block.png)
+
+After added value you can watch it inside watched block:
+![Admin actions](./images/admin-actions-watched-block.png)
+
 
 
 #### Userstat admin actions