Enrichment doc.

BinChengZhao · Jul 25, 2021 · f0ab06f · f0ab06f
1 parent 8f6e5d7
commit f0ab06f
Show file tree

Hide file tree

Showing 4 changed files with 242 additions and 12 deletions.
diff --git a/doc/promotional_doc.md b/doc/promotional_doc.md
@@ -1,10 +1,8 @@
 [delicate](https://github.com/BinChengZhao/delicate) A lightweight and distributed task scheduling platform written in rust.
 
-//TODO: there is features and pictures.
-//TODO: 1.Introduction (repo address) 2.Function 3.Technology stack 4.roadmap 5.Thanks (repo address).
 
 <a href="">
-    <img src="https://github.com/BinChengZhao/delicate/blob/main/doc/delicate_logo.png"
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/delicate_logo.png"
          alt="delicate logo" title="delicate" height="125" width="125"  align="right"/>
 </a>
 
@@ -22,7 +20,7 @@
 - **Upgrade:**  Dynamic upgrade of the system (upgrade is done by obtaining the latest source code and performing database migration.
 
 
-![architecture](https://github.com/BinChengZhao/delicate/blob/main/doc/architecture.svg)
+![architecture](https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/delicate-architecture.svg)
 
 ## Technology-stack
 
@@ -54,4 +52,58 @@ We would like to thank the whole community and code contributors. In particular,
 
 
 Thanks to users reporting spelling mistakes on the documentation. This is always appreciated.
-Thanks to users joining us provide feedbacks, discuss features, and get assistance!
+Thanks to users joining us provide feedbacks, discuss features, and get assistance!
+
+
+## Renderings
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/dashboard.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_list_operation.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_logs.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_log_kill.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/executor_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/group_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/group_inner_bind.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_logs_2.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/user_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
diff --git a/doc/promotional_doc_zh_cn.md b/doc/promotional_doc_zh_cn.md
@@ -6,8 +6,6 @@
          alt="delicate logo" title="delicate" height="125" width="125"  align="right"/>
 </a>
 
-//TODO: there is features and pictures.
-//TODO: 1.Introduction (repo address) 2.Function 3.Technology stack 4.roadmap 5.Thanks (repo address).
 
 ## 特性
 - **友好的用户界面：** [前端]方便地管理任务和执行器，监控其状态，支持手动维护运行中的任务等。
@@ -16,11 +14,11 @@
 
 - **高可用性：** Delicate支持横向扩展。通过部署尽可能多的Delicate服务器和执行器，很容易实现高可用性和性能。
 
-- **高性能：** 轻量级和基本功能加快了性能，`delicate'的基本资源开销大约是（小于0.1%的cpu使用率，10m的内存.)
+- **高性能:** 轻量级和基本功能加快了性能，`delicate'的基本资源开销大约是（小于0.1%的cpu使用率，10m的内存.)
 
-- **可观察性:**有许多有意义的统计数据定期以图表的方式展现。
+- **可观察性:** 有许多有意义的统计数据定期以图表的方式展现。
 
-- **升级：**系统的动态升级（升级是通过获得最新的源代码和进行数据库迁移.)
+- **升级:** 系统的动态升级（升级是通过获得最新的源代码和进行数据库迁移.)
 
 
 
@@ -40,7 +38,7 @@ Ui: Ant Design
 
 
 
-[Quick-start](https://github.com/BinChengZhao/delicate/blob/main/doc/promotional_doc_zh_cn.md)
+[Quick-start](https://github.com/BinChengZhao/delicate/blob/main/doc/quick_start_zh_cn.md)
 
 
 ## 下一步是什么
@@ -57,4 +55,58 @@ Ui: Ant Design
 
 
 感谢用户报告文档中的拼写错误, 这非常感谢大家。
-感谢用户加入我们，提供反馈，讨论功能，并获得帮助!
+感谢用户加入我们，提供反馈，讨论功能，并获得帮助!
+
+
+## 效果图
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/dashboard.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_list_operation.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_logs.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_log_kill.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/executor_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/group_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/group_inner_bind.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_logs_2.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/user_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
diff --git a/doc/quick_start.md b/doc/quick_start.md
@@ -2,14 +2,78 @@ After the deployment, we can start using the delicate related functions.
 
 First login via .env (`INITIAL_ADMINISTRATOR_USER_NAME`) , the initialized user.
 
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/login_en.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
 First, we go to `execution-resources-executor-node` to maintain `delicate-executor` into our system as a machine resource and perform the activation operation.
 
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/executor_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/executor_create.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
 Then, go to the `execution-resources-execution-groups` menu to add our resource group and do binding with the corresponding `execution-node` to generate `binding items`.
 
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/group_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/group_inner_bind.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
 Next, go to the `Task List` to add our scheduling task and associate our `binding item`.
 
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_edit.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_list_operation.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
 When a task starts scheduling, a scheduling log is generated, and we can click the `More` button -> `View Log` for the specified task under the task list.
 
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_logs_2.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
+
 Each task run log corresponds to a `task instance`, which can be cancelled at any time when it is running. Tasks that have finished running, or have timed out, can be viewed with standard output and standard errors generated by the task execution.
 
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_log_kill.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
 For more content, please see doc.
diff --git a/doc/quick_start_zh_cn.md b/doc/quick_start_zh_cn.md
@@ -2,14 +2,76 @@
 
 首先通过 .env (`INITIAL_ADMINISTRATOR_USER_NAME`) , 初始化的用户进行登陆。
 
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/login_zh.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
 首先，我们进入`执行资源-执行节点`将`delicate-executor`作为机器资源维护进入我们的系统，并执行激活操作。
 
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/executor_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/executor_create.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
 然后，进入`执行资源-执行组`菜单添加我们的资源组，并与对应的`执行节点`做绑定生成`绑定项`。
 
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/group_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/group_inner_bind.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
 下一步，进入`任务列表`添加我们的调度任务，并关联我们的`绑定项`.
 
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_edit.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_list_operation.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_list.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
 当任务开始调度后，生成调度日志，我们可以通过任务列表下的指定任务点击`更多`按钮  -> `查看日志`。
 
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_logs_2.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
 每一个任务的运行日志都对应着一个`任务实例`, 在运行中的任务实例是可以随时取消的。已经运行完成，或者超时的任务可以查看任务执行后产生的标准输出与标准错误。
 
+<a href="">
+    <img src="https://delicate-rs-1301941387.cos.ap-beijing.myqcloud.com/delicate-rs/task_log_kill.jpg"
+         alt="" title="delicate" align="right"/>
+</a>
+
+
+
 更多内容请查看doc。