Skip to content

D
dlink
Unverified Commit 05c23841 authored by aiwenmo's avatar aiwenmo Committed by GitHub
Browse files
Options

[Document-324][doc]update registerCenter relevant 

[Document-324][doc]update registerCenter relevant
parents 14e8d146 f99cace7
Hide whitespace changes
Inline Side-by-side
Showing with 140 additions and 178 deletions
docs/zh-CN/_sidebar.md
View file @ 05c23841
...@@ -35,7 +35,7 @@ ...@@ -35,7 +35,7 @@
- [数据源管理](/zh-CN/administrator-guide/registerCenter/datasource_manage.md) - [数据源管理](/zh-CN/administrator-guide/registerCenter/datasource_manage.md)
- [告警管理](/zh-CN/administrator-guide/registerCenter/warning.md) - [告警管理](/zh-CN/administrator-guide/registerCenter/warning.md)
- [jar管理](/zh-CN/administrator-guide/registerCenter/jar_manager.md) - [jar管理](/zh-CN/administrator-guide/registerCenter/jar_manager.md)
- 文档管理 - [文档管理](/zh-CN/administrator-guide/registerCenter/document_manager.md)
- [元数据管理](/zh-CN/administrator-guide/metadata.md) - [元数据管理](/zh-CN/administrator-guide/metadata.md)
- [快速使用快捷键](/zh-CN/administrator-guide/Hotkey.md) - [快速使用快捷键](/zh-CN/administrator-guide/Hotkey.md)
- 系统设置 - 系统设置
......
docs/zh-CN/administrator-guide/Hotkey.md
View file @ 05c23841
保存 **在数据开发编辑器内可使用以下快捷键**
``` | 功能描述 | 快捷键 | 备注 |
Ctrl + s |---------| -------------------------- | ------ |
``` | 全屏开发 | `F2` | |
| 关闭弹框及全屏 | `Esc` | |
校验 | 保存 | `Ctrl + S` | |
| 校验 | `Alt + 2` | |
``` | 美化 | `Alt + 3` | |
Alt + 2 | 搜索 | `Ctrl + F` | |
``` | 替换 | `Ctrl + H` | |
| 撤销 | `Ctrl + Z` | |
美化 | 重做 | `Ctrl + Y` | |
| 注释 | `Ctrl + /` | |
``` | 缩进 | `选中 + Tab` | |
Alt + 3 | 取消缩进 | `选中 + Shift + Tab` | |
``` | 选中后续 | `Shift + Alt + Right` | |
| 格式化 | `Shift + Alt + F` | |
搜索 | 编辑多行 | `Ctrl + Shift + Up/Down` | |
| 复制一行 | `Shift + Alt + Up/Down` | |
``` | 删除一行 | `Ctrl + Shift + K` | |
Ctrl + F | 匹配下一个 | `Ctrl + F3` | |
``` | 匹配上一个 | `Ctrl + Shift + F3` | |
| 前往下一个高亮 | `F7` | |
替换 | 前往上一个高亮 | `Shift +F7` | |
| 前面追加换行 | `Ctrl + Shift + End` | |
``` | 追加换行 | `Ctrl + End` | |
Ctrl + H | 上下换位 | `Alt + Up/Down` | |
``` | 折叠/展开 | `Ctrl + Shift + [/]` | |
| 更多快捷键 | `F1` | |
撤销
```
Ctrl + Z
```
重做
```
Ctrl + Y
```
注释
```
Ctrl + /
```
缩进
```
选中 + Tab
```
取消缩进
```
选中 + Shift + Tab
```
选中后续
```
Shift + Alt + Right
```
格式化
```
Shift + Alt + F
```
编辑多行
```
Ctrl + Shift + Up/Down
```
复制一行
```
Shift + Alt + Up/Down
```
删除一行
```
Ctrl + Shift + K
```
匹配下一个
```
Ctrl + F3
```
匹配上一个
```
Ctrl + Shift + F3
```
前往下一个高亮
```
F7
```
前往上一个高亮
```
Shift +F7
```
前面追加换行
```
Ctrl + Shift + End
```
追加换行
```
Ctrl + End
```
上下换位
```
Alt + Up/Down
```
折叠/展开
```
Ctrl + Shift + [/]
```
全屏
```
F2
```
关闭弹框及全屏
```
Esc
```
更多快捷键
```
F1
```
docs/zh-CN/administrator-guide/registerCenter/cluster_manage.md
View file @ 05c23841
...@@ -20,11 +20,9 @@ ...@@ -20,11 +20,9 @@
首先进入注册中心的集群管理中的集群实例管理，新建一个集群实例，点击新建，添加Flink集群，参数配置完成后，点击提交即可。 首先进入注册中心的集群管理中的集群实例管理，新建一个集群实例，点击新建，添加Flink集群，参数配置完成后，点击提交即可。
![实例新建](http://www.aiwenmo.com/dinky/dev/docs/%E5%AE%9E%E4%BE%8B%E6%96%B0%E5%BB%BA.png) ![cluster_manager_list](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/cluster_manager/cluster_manager_list.png)
![实例配置提交](http://www.aiwenmo.com/dinky/dev/docs/%E5%AE%9E%E4%BE%8B%E9%85%8D%E7%BD%AE%E6%8F%90%E4%BA%A4.png) ![create_flink_cluster](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/cluster_manager/create_flink_cluster.png)
![实例配置提交1](http://www.aiwenmo.com/dinky/dev/docs/%E5%AE%9E%E4%BE%8B%E9%85%8D%E7%BD%AE%E6%8F%90%E4%BA%A41.png)
**参数配置说明：** **参数配置说明：**
......
docs/zh-CN/administrator-guide/registerCenter/datasource_manage.md
View file @ 05c23841
## 数据源管理列表
![database_manager_list](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/database_manager/database_manager_list.png)
## 创建数据源
当用户使用Dinky做为数据开发工具时,用户首先需要进入<span style=''>注册中心数据源管理</span>,新建数据库连接即可。 当用户使用Dinky做为数据开发工具时,用户首先需要进入<span style=''>注册中心数据源管理</span>,新建数据库连接即可。
![image-20220310221602049](http://www.aiwenmo.com/dinky/dev/docs/image-20220310221602049.png) ![create_database_jdbc](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/database_manager/create_database_jdbc.png)
![create_database_jdbc_mysql](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/database_manager/create_database_jdbc_mysql.png)
**名称:** 输入英文唯一标识; **名称:** 输入英文唯一标识;
......
docs/zh-CN/administrator-guide/registerCenter/document_manager.md 0 → 100644
View file @ 05c23841
## 文档管理List
![document_manager_list](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/document_manager/document_manager_list.png)
## 查看文档描述
![document_manager_list](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/document_manager/document_show_desc.png)
## 创建文档
![create_document](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/document_manager/create_document.png)
## 维护文档
![update_document](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/document_manager/update_document.png)
**参数配置说明:**
- **名称:** 文档名称 (必填) 此处定义可在数据开发中使用触发快捷提示 ;
- **文档类型:** 文档类型 (必填) ;
- **类型:** 定义函数类型 (必填) ;
- **子类型:** 定义函数子类型 (必填) ;
- **描述:** 该文档描述 ;
- **填充值:**
- 如果希望在函数 _`LTRIM(parms)`_ 中输入参数 则此处填充值语法为: _`LTRIM(${1:})`_ 此时的1代表第一个光标 ; 如需多个 数字+1即可 tab键切换光标 ;
- 如不需要参数则直接输入期望填充值 ;
- **版本:** 文档版本 (必填) ;
**填充值提示效果:**
![show_hotkey_tips](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/document_manager/show_hotkey_tips.png)
docs/zh-CN/administrator-guide/registerCenter/warning.md
View file @ 05c23841
...@@ -7,17 +7,13 @@ ...@@ -7,17 +7,13 @@
首先要进入<span style="">注册中心</span>，选择<span>报警管理</span>，然后选择左侧的报警实例管理，创建一个告警实例。然后选择对应的报警插件(当前支持钉钉及企业微信)。然后选择报警组管理，创建一个报警组。 首先要进入<span style="">注册中心</span>，选择<span>报警管理</span>，然后选择左侧的报警实例管理，创建一个告警实例。然后选择对应的报警插件(当前支持钉钉及企业微信)。然后选择报警组管理，创建一个报警组。
## 报警实例管理 ## 报警实例管理
新建一个报警实例，选择新建 新建一个报警实例，选择新建
![image-20220313231030171](http://www.aiwenmo.com/dinky/dev/docs/image-20220313231030171.png) ![alert_instance_list](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/warning/alert_instance_list.png)
![image-20220313231641014](http://www.aiwenmo.com/dinky/dev/docs/image-20220313231641014.png)
![create_alert_instance](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/warning/create_alert_instance.png)
点击<span>钉钉或者企业微信</span>,创建报警实例配置。报警实例配置完成，就可以创建报警组。 点击<span>钉钉或者企业微信</span>,创建报警实例配置。报警实例配置完成，就可以创建报警组。
...@@ -25,15 +21,15 @@ ...@@ -25,15 +21,15 @@
新建一个报警组，选择新建 新建一个报警组，选择新建
![image-20220313232311137](http://www.aiwenmo.com/dinky/dev/docs/image-20220313232311137.png) ![alert_group_list](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/warning/alert_group_list.png)
![image-20220313232557068](http://www.aiwenmo.com/dinky/dev/docs/image-20220313232557068.png) ![create_alert_group](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/warning/create_alert_group.jpg)
## 钉钉 ## 钉钉
如果用户使用钉钉进行报警，请在报警实例中选择报警实例管理，选择新建<span>钉钉</span>报警实例。钉钉的配置如下： 如果用户使用钉钉进行报警，请在报警实例中选择报警实例管理，选择新建<span>钉钉</span>报警实例。钉钉的配置如下：
![image-20220313233200594](http://www.aiwenmo.com/dinky/dev/docs/image-20220313233200594.png) ![create_dingdingtalk_alert](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/warning/create_dingdingtalk_alert.png)
**参数配置：** **参数配置：**
...@@ -48,17 +44,15 @@ ...@@ -48,17 +44,15 @@
**说明:** 自定义机器人发送消息时，在“被@人列表”里面的人员收到该消息时，会有@消息提醒。 **说明:** 自定义机器人发送消息时，在“被@人列表”里面的人员收到该消息时，会有@消息提醒。
[自定义机器人接入开发文档](https://open.dingtalk.com/document/robots/custom-robot-access) [钉钉-开发者文档](https://open.dingtalk.com/document/robots/custom-robot-access)
## 企业微信 ## 企业微信
如果用户使用企业微信进行报警，请在报警实例中选择报警实例管理，选择新建<span>企业微信</span>报警实例。 如果用户使用企业微信进行报警，请在报警实例中选择报警实例管理，选择新建<span>企业微信</span>报警实例。
### 微信企业应用配置 ### 微信企业应用配置
![image-20220328212335387](http://www.aiwenmo.com/dinky/dev/docs/image-20220328212335387.png) ![create_wechat_alert](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/warning/create_wechat_app_alert.png)
**参数配置：** **参数配置：**
...@@ -74,7 +68,7 @@ ...@@ -74,7 +68,7 @@
### 微信企业群聊配置 ### 微信企业群聊配置
![image-20220328212631158](http://www.aiwenmo.com/dinky/dev/docs/image-20220328212631158.png) ![create_wechat_chat_alert](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/warning/create_wechat_chat_alert.png)
**参数配置：** **参数配置：**
...@@ -91,6 +85,65 @@ ...@@ -91,6 +85,65 @@
其中发送方式分别对应企微文档： 其中发送方式分别对应企微文档：
[应用](https://work.weixin.qq.com/api/doc/90000/90135/90236) [群聊](https://work.weixin.qq.com/api/doc/90000/90135/90248) [应用-开发者文档](https://work.weixin.qq.com/api/doc/90000/90135/90236)
[群聊-开发者文档](https://work.weixin.qq.com/api/doc/90000/90135/90248)
发送消息对应文档中的 content，与此相对应的值的变量为 {msg}
## 飞书
发送消息对应文档中的 content，与此相对应的值的变量为 {msg} 如果用户使用飞书进行报警，请在报警实例中选择报警实例管理，选择新建<span>飞书</span>报警实例。
![create_feishu_alert](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/warning/create_feishu_alert.png)
**参数配置：**
- **名称：** 自定义;
- **发送方式:** 群聊；
- **WebHook地址:** Webhook地址，如https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxx
- **关键字:** 作为发送信息的title 标记；
- **@所有人:** 默认禁用，如果@所有人需要开启；
- **被@用户:**飞书的用户ID；
- **是否启用:** 默认禁用，需要开启；
- **展示方式类型:** 支持富文本和纯文本；
**说明:** @所有人与被@用户可相互切换
[飞书-自定义机器人接入开发文档](https://open.feishu.cn/document/ukTMukTMukTM/ucTM5YjL3ETO24yNxkjN)
## 邮箱
如果用户使用邮箱进行报警，请在报警实例中选择报警实例管理，选择新建<span>邮箱</span>报警实例。
![create_email_alert](http://www.aiwenmo.com/dinky/docs/zh-CN/administrator-guide/registerCenter/warning/create_email_alert.png)
**参数配置：**
- **名称：** 自定义;
- **发送方式:** 邮件发送；
- **收件人:** 收件人邮箱,多个使用逗号分开；
- **抄送人:** 抄送人邮箱,多个使用逗号分开；
- **邮件服务器Host:** 邮件服务器主机；
- **邮件服务器Port:** 邮件服务器端口；
- **发送者sender昵称:** 发送者到目标邮箱的显示昵称；
- **是否开启邮箱验证:**
- 是
- **邮箱用户名:** 邮箱；
- **邮箱密码:** 邮箱密码；
- 否
- 表单无显示
- **是否开启tls证书验证:** 是/否；
- **是否开启SSL验证:**
- 是
- **受信任域:** 自行设置 可设置为*；
- 否
- 表单无显示
- **是否启用:** 默认禁用，需要开启；
- **展示方式类型:**
- 支持文本 表格 附件 附件+表格；
- PS: 需要注意的是 当选择 附件 || 附件+表格 时:
- **XLS存放目录:** 非必填 默认路径为: /tmp/xls
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment