Merge b7b580a into a85ec54

Author: qianmoQ

.github/ISSUE_TEMPLATE/bug-report-on-component.md

@@ -2,7 +2,7 @@
 name: Bug report On xxxx
 about: Create a report to help us improve
 title: Bug report for xxxx On xxxx
-labels: bug
+labels: Bug
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/documentation-report.md

@@ -0,0 +1,17 @@
+---
+name: Documentation report
+about: Report something incorrect or missing in documentation
+title: Documentation for XXXX
+labels: Documentation
+assignees: ''
+
+---
+
+(you don't have to strictly follow this form)
+
+**Describe the issue**
+A clear and concise description of what's wrong in documentation.
+
+**Additional context**
+Add any other context about the problem here.
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -2,7 +2,7 @@
 name: Feature request
 about: Suggest an idea for this project
 title: Feature request for XXXX
-labels: enhancement
+labels: Enhancement
 assignees: ''
 
 ---

.github/ISSUE_TEMPLATE/release-notes-for-version.md

@@ -2,7 +2,7 @@
 name: Release notes for Version
 about: New version released
 title: Release notes for XXXX
-labels: release
+labels: Release
 assignees: ''
 
 ---

docs/docs/assets/images/others/management/datasource/configuration.png

@@ -3,7 +3,7 @@ template: overrides/main.html
 icon: material/gesture-tap-button
 ---
 
-DBM Version for `1.14.0` is development!
+DBM Version for `1.15.0` is development!
 
 !!! danger "Warning"
 
@@ -13,27 +13,24 @@ DBM Version for `1.14.0` is development!
 
 ---
 
-
 #### UI
 
 ---
 
-
 #### Optimize
 
 ----
 
-
 #### Docs
 
 ---
 
-
 #### Bug
 
 ---
 
-
 #### Contributors (In no particular order)
 
 ---
+
+- @qianmoQ

docs/docs/assets/images/others/management/datasource/delete.png

@@ -0,0 +1,115 @@
+---
+template: overrides/main.html
+---
+
+The data source is mainly used to manage the Clickhouse service data source for later query monitoring.
+
+### Create a data source
+
+---
+
+Move the mouse to the top menu `Management` and wait for the drop-down options to appear, click `DataSource` to enter the data source management interface, which is similar to the following page
+
+![Index](../../assets/images/others/management/datasource/index.png)
+
+!!! note
+
+    When opening the software for the first time, an `Add` blue button will be displayed in the middle of the page!
+
+Click the `Add` button (blue) to add a data source. The following popup appears:
+
+##### DataSource Type
+
+---
+
+![Select Type](../../assets/images/others/management/datasource/select_type.png)
+
+In the first step, we need to select the type of data source. We click the `ClickHouse` icon to select the data source, and click `Next` to configure the parameters.
+
+##### DataSource Configuration
+
+---
+
+![Configuration](../../assets/images/others/management/datasource/configuration.png)
+
+It has two types of datasource parameters：
+
+###### Basic Settings
+
+- `Alias`: This field is only used to mark the alias of the current property. The default `localhost` is easy to remember and has no special meaning.
+- `Protocol`: Connection service protocol, default `http`
+- `Host`: Enter the hostname or IP address of the remote server here, the default is `localhost`
+- `Port`: Enter the host address of the remote server here, corresponding to the open port, the default is `8123`
+- `User Name`: Connection service user name, input when setting, default `default`
+- `Password`: Connection service user password, if set, please enter
+
+###### Experimental Settings
+
+!!! note "Warning"
+
+    This configuration may be unstable, but it will not cause software errors, only some functions will not take effect, and will continue to be converted to official functions in the future
+
+- `MaxTotal`: Maximum number of data query rows
+
+---
+
+When we fill in the basic configuration, click the `Test` button at the bottom, and the `OK` button can be clicked after the test is passed.
+
+After clicking the `OK` button, we will save the configuration information you wrote for the next time
+
+Configuration information can be saved in two states
+
+- `Stop`: A stopped state, meaning the service is currently unavailable, marked with a stop icon
+- `Start`: Available status, indicating that the service is currently available for operations such as query, and is marked with a play icon
+
+!!! note
+
+    We do not allow saving of untested services, please make sure it is available to save again.
+
+After the configuration is saved successfully, the pop-up box will be closed and the list of data just saved will be displayed on the page
+
+![List](../../assets/images/others/management/datasource/list.png)
+
+#### DataSource Operations
+
+---
+
+There are two buttons at the top of the list
+
+:material-plus-circle:{.blue} for adding new data sources
+
+:material-refresh: for refreshing all data sources
+
+!!! warning
+
+    This operation will traverse all data sources to request to verify the availability of data sources
+
+##### List of data sources
+
+|Field| Description                                   |
+|---|-----------------------------------------------|
+|Alias| DataSource Alias                              |
+|Name| The name of the data source build             |
+| Host | The hostname of the data source configuration |
+|Protocol| access protocol used                          |
+|User Name| Username to access the service                |
+|Version| The version of the current server             |
+|Action| Additional Operations for Data Sources        |
+
+If the test fails, the following list will be displayed
+
+![Service failure](../../assets/images/1.13.0/service_failure.png)
+
+##### Delete DataSource
+
+There is a :material-delete-circle:{.red} icon under the `Action` column of the list data of the data source, when we click it, the following content will appear
+
+![Delete](../../assets/images/others/management/datasource/delete.png)
+
+The data source will be deleted after clicking the `OK` button
+
+Click `Cancel` to close the prompt box without doing anything
+
+##### Modify DataSource
+
+The modification and addition operations are basically the same, the difference is that the modification will fill the data into the corresponding input box when the pop-up box is called up.

docs/docs/assets/images/others/management/datasource/index.png

@@ -0,0 +1,115 @@
+---
+template: overrides/main.html
+---
+
+数据源主要用于管理 Clickhouse 服务数据源，用于后期查询监控。
+
+### 创建数据源
+
+---
+
+鼠标移向顶部菜单 `Management` 等待下拉选择项出来后, 点击 `DataSource` 即可进入数据源管理界面, 它类似于以下页面
+
+![Index](../../assets/images/others/management/datasource/index.png)
+
+!!! note
+
+    初次打开入软件时,在页面中间会展示一个 `Add` 蓝色按钮!
+
+单击 `Add` 按钮（蓝色）添加数据源。出现以下弹出框：
+
+##### 数据源类型
+
+---
+
+![Select Type](../../assets/images/others/management/datasource/select_type.png)
+
+第一步我们需要选择数据源的类型, 我们点击 `ClickHouse` 图标选择该数据源,点击 `Next` 下一步进行参数配置
+
+##### 数据源配置
+
+---
+
+![Configuration](../../assets/images/others/management/datasource/configuration.png)
+
+有两种类型的数据源参数：
+
+###### 基本设置
+
+- `Alias`: 该字段仅用于标记当前属性的别名，默认 `localhost` 好记，无特殊含义
+- `Protocol`: 连接服务协议，默认 `http`
+- `Host`: 这里输入远程服务器的主机名或IP地址，默认 `localhost`
+- `Port`: 这里输入远程服务器的主机地址，对应开放的端口，默认 `8123`
+- `User Name`: 连接服务用户名，设置时输入，默认 `default`
+- `Password`: 连接服务用户密码，如果设置请输入
+
+###### 实验性设置
+
+!!! note "注意"
+
+    该配置可能不稳定,但是它不会导致软件错误,只会出现部分功能不生效,后续会持续转换为正式功能
+
+- `MaxTotal`: 最大的数据查询行数
+
+---
+
+当我们填写基本配置完成后点击底部 `Test` 按钮, 测试通过后 `OK` 按钮即可点击.
+
+点击 `OK` 按钮后, 我们将保存您编写的配置信息，以备下次使用
+
+配置信息可以两种状态保存
+
+- `Stop`: 停止状态，表示服务当前不可用，标有停止图标
+- `Start`: 可用状态, 表示该服务当前可用于查询等操作，并标有播放图标
+
+!!! note
+
+    未测试通过的服务我们不允许保存,请确保它可用再次进行保存操作.
+
+配置保存成功后会关闭弹出框并展示刚刚保存的数据列表在页面中
+
+![List](../../assets/images/others/management/datasource/list.png)
+
+#### 数据源操作
+
+---
+
+在列表的顶部拥有两个按钮
+
+:material-plus-circle:{.blue} 按钮用于添加新数据源
+
+:material-refresh: 按钮用于刷新所有数据源
+
+!!! warning
+
+    该操作将会遍历所有的数据源进行请求验证数据源的可用性
+
+##### 数据源列表
+
+|字段| 描述       |
+|---|----------|
+|Alias| 该数据源别名   |
+|Name| 数据源构建的名称 |
+| Host | 数据源配置的主机名 |
+|Protocol| 使用的访问协议  |
+|User Name| 访问服务的用户名 |
+|Version|当前服务器的版本|
+|Action|数据源的额外操作|
+
+如果测试有失败的会展示如下列表
+
+![Service failure](../../assets/images/1.13.0/service_failure.png)
+
+##### 删除数据源
+
+在数据源的列表数据的 `Action` 列下拥有一个 :material-delete-circle:{.red} 图标, 当我们点击它后会出现如下内容
+
+![Delete](../../assets/images/others/management/datasource/delete.png)
+
+点击 `OK` 按钮后数据源将被删除
+
+点击 `Cancel` 关闭提示框不做任何处理
+
+##### 修改数据源
+
+修改和添加操作基本一致,不同的是修改在调起弹出框时会将数据填充到相应的输入框内.

docs/docs/assets/images/others/management/datasource/list.png

@@ -0,0 +1,40 @@
+---
+template: overrides/main.html
+---
+
+This document mainly introduces how we use the connection monitoring function provided by the software.
+
+Move the mouse to the top menu `Monitor` and wait for the drop-down options to appear, click `Connection` to enter the connection monitoring interface, which is similar to the following page
+
+![img.png](../../assets/images/others/monitor/connection/img.png)
+
+The upper part of the page is the data chart display & function configuration area, and the lower part is the detailed data list area
+
+#### Data charting & Feature Configuration
+
+---
+
+The drop-down selection box on the top left is used to select the configured data source. After selection, the software will initiate a request to the service to obtain information, and return a data chart similar to the following
+
+![img_1.png](../../assets/images/others/monitor/connection/img_1.png)
+
+The graph shows the number of various active connections
+
+On the top right side there is a `Numeric` and `Selector`
+
+`Numeric input` is used to mark the split time of refresh data (unit: second)
+
+The `selector` is used to mark whether to automatically refresh the data. When this option is turned on, the software will refresh the data according to the `digital input` data
+
+#### Details of the data
+
+---
+
+The drop-down selection box on the top left is used to select the configured data source. After selection, the software will initiate a request to the service to obtain information, and return results similar to the following
+
+![img_2.png](../../assets/images/others/monitor/connection/img_2.png)
+
+| Property   | Description                            |
+|------------|----------------------------------------|
+| categories | Connection type (using name tag)       |
+| value      | The number of uses of the current type |

docs/docs/assets/images/others/management/datasource/select_type.png

@@ -0,0 +1,40 @@
+---
+template: overrides/main.html
+---
+
+本文档主要介绍我们如何使用软件提供的连接监控功能。
+
+鼠标移向顶部菜单 `Monitor` 等待下拉选择项出来后, 点击 `Connection` 即可进入连接监控界面, 它类似于以下页面
+
+![img.png](../../assets/images/others/monitor/connection/img.png)
+
+在页面中上半部分为数据图表展示&功能配置区, 下半部分为详细数据列表区
+
+#### 数据图表 & 功能配置
+
+---
+
+在顶部左侧下拉选择框用于选择配置好的数据源, 选择后软件会向服务发起请求获取信息, 返回类似以下数据图表
+
+![img_1.png](../../assets/images/others/monitor/connection/img_1.png)
+
+图表中会展示各种活跃连接的数量
+
+在顶部的右侧有一个 `数字输入器` 和 `选择器`
+
+`数字输入器` 用于标记刷新数据的分割时间(单位秒)
+
+`选择器` 用于标记是否自动刷新数据,当开启该选项时,软件会根据 `数字输入器` 数据进行数据刷新
+
+#### 数据详情
+
+---
+
+在顶部左侧下拉选择框用于选择配置好的数据源, 选择后软件会向服务发起请求获取信息, 返回类似以下结果
+
+![img_2.png](../../assets/images/others/monitor/connection/img_2.png)
+
+| 属性         | 描述           |
+|------------|--------------|
+| categories | 连接类型(使用名称标记) |
+| value      | 当前类型的使用数量    |