diff --git a/docs/configs/docsdev.js b/docs/configs/docsdev.js index ad39afefb6..b552ff4d50 100644 --- a/docs/configs/docsdev.js +++ b/docs/configs/docsdev.js @@ -97,6 +97,10 @@ export default { title: 'Task Instance', link: '/en-us/docs/dev/user_doc/guide/project/task-instance.html', }, + { + title: 'Task Definition', + link: '/zh-cn/docs/dev/user_doc/guide/project/task-definition.html', + }, ] }, { @@ -251,6 +255,15 @@ export default { title: 'Security', link: '/en-us/docs/dev/user_doc/guide/security.html', }, + { + title: 'How-To', + children: [ + { + title: 'General Setting', + link: '/en-us/docs/dev/user_doc/guide/howto/general-setting.html', + } + ], + }, { title: 'Open API', link: '/en-us/docs/dev/user_doc/guide/open-api.html', @@ -398,6 +411,10 @@ export default { title: '任务实例', link: '/zh-cn/docs/dev/user_doc/guide/project/task-instance.html', }, + { + title: '任务定义', + link: '/zh-cn/docs/dev/user_doc/guide/project/task-definition.html', + }, ] }, { @@ -552,6 +569,15 @@ export default { title: '安全中心', link: '/zh-cn/docs/dev/user_doc/guide/security.html', }, + { + title: '常见操作', + children: [ + { + title: '通用设置', + link: '/zh-cn/docs/dev/user_doc/guide/howto/general-setting.html', + } + ], + }, { title: 'API调用', link: '/zh-cn/docs/dev/user_doc/guide/open-api.html', diff --git a/docs/docs/en/guide/howto/general-setting.md b/docs/docs/en/guide/howto/general-setting.md new file mode 100644 index 0000000000..fc2588bba4 --- /dev/null +++ b/docs/docs/en/guide/howto/general-setting.md @@ -0,0 +1,22 @@ +# General Setting + +## Language + +DolphinScheduler supports two types of built-in language which include `English` and `Chinese`. You could click the button +on the top control bar named `English` and `Chinese` and change it to another one when you want to switch the language. +The entire DolphinScheduler page language will shift when you switch the language selection. + +## Theme + +DolphinScheduler supports two types of built-in theme which include `Dark` and `Light`. When you want to change the theme +of DolphinScheduler, all you have to do is click the button named `Dark`(or `Light`) on the top control bar and on the left +of to [language](#language) control button. + +## Time Zone + +DolphinScheduler support time zone setting. The build-in time zone is based on the server you run DolphinScheduler. You could +click the button on the right of the [language](#language) button and then click `Choose timeZone` to choose the time zone +you want to switch. All time related components will adjust their time zone according to the time zone setting you select. + +DolphinScheduler uses UTC time for the internal communication, the time zone you choose only changes the display time format +base on the UTC time. When you choose time zone `TIME ZONE`, we just convert the UTC time to the zone you prefer. diff --git a/docs/docs/en/guide/monitor.md b/docs/docs/en/guide/monitor.md index 420a190728..5ccb95d0da 100644 --- a/docs/docs/en/guide/monitor.md +++ b/docs/docs/en/guide/monitor.md @@ -4,19 +4,19 @@ - Service management is mainly to monitor and display the health status and basic information of each service in the system. -## Monitor Master Server +### Master Server - Mainly related to master information. ![master](/img/new_ui/dev/monitor/master.png) -## Monitor Worker Server +### Worker Server - Mainly related to worker information. ![worker](/img/new_ui/dev/monitor/worker.png) -## Monitor DB +### Database - Mainly the health status of the DB. @@ -24,9 +24,18 @@ ## Statistics Management +### Statistics + ![statistics](/img/new_ui/dev/monitor/statistics.png) - Number of commands wait to be executed: statistics of the `t_ds_command` table data. - The number of failed commands: statistics of the `t_ds_error_command` table data. - Number of tasks wait to run: count the data of `task_queue` in the ZooKeeper. - Number of tasks wait to be killed: count the data of `task_kill` in the ZooKeeper. + +### Audit Log + +The audit log provides information about who accesses the system and the operations made to the system and record related +time, which strengthen the security of the system and maintenance. + +![audit-log](/img/new_ui/dev/monitor/audit-log.jpg) diff --git a/docs/docs/en/guide/project/task-definition.md b/docs/docs/en/guide/project/task-definition.md new file mode 100644 index 0000000000..53646eb2d9 --- /dev/null +++ b/docs/docs/en/guide/project/task-definition.md @@ -0,0 +1,13 @@ +# Task Definition + +Task definition allows to modify or operate tasks at the task level rather than modifying them in the workflow definition. +We already have workflow level task editor in [workflow definition](workflow-definition.md) which you can click the specific +workflow and then edit its task definition. It is depressing when you want to edit the task definition but do not remember +which workflow it belongs to. So we decide to add `Task Definition` view under `Task` menu. + +![task-definition](/img/new_ui/dev/project/task-definition.jpg) + +In this view, you can create, query, update, delete task definition by click the related button in `operation` column. The +most exciting thing is you could query task by task name in the wildcard, and it is useful when you only remember the task +name but forget which workflow it belongs to. It is also supported query by the task name alone with `Task Type` or +`Workflow Name` diff --git a/docs/docs/zh/guide/howto/general-setting.md b/docs/docs/zh/guide/howto/general-setting.md new file mode 100644 index 0000000000..1b7744b3f9 --- /dev/null +++ b/docs/docs/zh/guide/howto/general-setting.md @@ -0,0 +1,19 @@ +# 通用配置 + +## 语言 + +DolphinScheduler 支持两种内置语言，包括 `English` 和 `Chinese` 。您可以点击顶部控制栏名为 `English` 或 `Chinese` 的按钮切换语言。 +当您将语言从一种切换为另一种时，您所有 DolphinScheduler 的页面语言页面将发生变化。 + +## 主题 + +DolphinScheduler 支持两种类型的内置主题，包括 `Dark` 和 `Light`。当您想改变主题时，只需单击顶部控制栏在 [语言](#语言) 左侧名为 `Dark`(or `Light`) +的按钮即可。 + +## 时区 + +DolphinScheduler 支持时区设置。默认时区基于您运行 DolphinScheduler 服务器的时区。如果你想要切换时区，可以点击 [语言](#语言) 按钮右侧的时区按钮， +然后点击 `请选择时区` 进行时区选择。当切换完成后，所有与时间相关的组件都将更改。 + +DolphinScheduler 内部通讯，以及任务主流程中使用 UTC 时间，在界面上显示的时间均是在 UTC 时间基础上进行时区格式化的，意味着当你切换了时区后， +只是将格式化的时间从一个时区切换到另一个时区。 diff --git a/docs/docs/zh/guide/monitor.md b/docs/docs/zh/guide/monitor.md index 34c15fe8cc..f5e8709f8e 100644 --- a/docs/docs/zh/guide/monitor.md +++ b/docs/docs/zh/guide/monitor.md @@ -4,19 +4,19 @@ - 服务管理主要是对系统中的各个服务的健康状况和基本信息的监控和显示 -### Master 监控 +### Master - 主要是 master 的相关信息。 ![master](/img/new_ui/dev/monitor/master.png) -### Worker 监控 +### Worker - 主要是 worker 的相关信息。 ![worker](/img/new_ui/dev/monitor/worker.png) -### DB 监控 +### Database - 主要是 DB 的健康状况 @@ -24,9 +24,17 @@ ## 统计管理 +### Statistics + ![statistics](/img/new_ui/dev/monitor/statistics.png) - 待执行命令数：统计 t_ds_command 表的数据 - 执行失败的命令数：统计 t_ds_error_command 表的数据 - 待运行任务数：统计 Zookeeper 中 task_queue 的数据 - 待杀死任务数：统计 Zookeeper 中 task_kill 的数据 + +### 审计日志 + +审计日志的记录提供了有关谁访问了系统，以及他或她在给定时间段内执行了哪些操作的信息，他对于维护安全都很有用。 + +![audit-log](/img/new_ui/dev/monitor/audit-log.jpg) diff --git a/docs/docs/zh/guide/project/task-definition.md b/docs/docs/zh/guide/project/task-definition.md new file mode 100644 index 0000000000..8079484378 --- /dev/null +++ b/docs/docs/zh/guide/project/task-definition.md @@ -0,0 +1,9 @@ +# 任务定义 + +任务定义允许您在基于任务级别而不是在工作流中操作修改任务。再此之前，我们已经有了工作流级别的任务编辑器，你可以在[工作流定义](workflow-definition.md) +单击特定的工作流，然后编辑任务的定义。当您想编辑特定的任务定义但不记得它属于哪个工作流时，这是令人沮丧的。所以我们决定在 `任务` 菜单下添加 `任务定义` 视图。 + +![task-definition](/img/new_ui/dev/project/task-definition.jpg) + +在该视图中，您可以通过单击 `操作` 列中的相关按钮来进行创建、查询、更新、删除任务定义。最令人兴奋的是您可以通过通配符进行全部任务查询，当您只 +记得任务名称但忘记它属于哪个工作流时是非常有用的。也支持通过任务名称结合使用 `任务类型` 或 `工作流程名称` 进行查询。 diff --git a/docs/img/new_ui/dev/monitor/audit-log.jpg b/docs/img/new_ui/dev/monitor/audit-log.jpg new file mode 100644 index 0000000000..bc396ad303 Binary files /dev/null and b/docs/img/new_ui/dev/monitor/audit-log.jpg differ diff --git a/docs/img/new_ui/dev/project/task-definition.jpg b/docs/img/new_ui/dev/project/task-definition.jpg new file mode 100644 index 0000000000..cd2db4e8ce Binary files /dev/null and b/docs/img/new_ui/dev/project/task-definition.jpg differ