improve: 前端项目工程文件目录修改后文档同步 #153 (#161)

* improve: 前端项目工程文件目录修改后文档同步 #153 * docs: 国际化翻译脚本优化，新增首次运行说明
TencentBlueKing · Apr 18, 2019 · ce21043 · ce21043
1 parent 6c21428
commit ce21043
Show file tree

Hide file tree

Showing 25 changed files with 69 additions and 68 deletions.
diff --git a/docs/apidoc/en/create_periodic_task.md b/docs/apidoc/en/create_periodic_task.md
@@ -284,7 +284,7 @@ constant value
 |-----------|----------|-----------|
 |  start_event      |    dict    |      start node     |
 |  end_event      |    dict    |      end node    |
-|  activities      |    dict    |      task node（atoms or subprocess）info    |
+|  activities      |    dict    |      task node（standard plugins or subprocess）info    |
 |  gateways      |    dict    |      gateways（parallel gateway、exclusive gateway、exclusive gateway）info    |
 |  flows      |    dict    |      sequenceFlow（the line between nodes）info    |
 |  constants      |    dict    |  global variables, details are described below    |
@@ -304,5 +304,5 @@ KEY, the format is like ${key}
 |  desc      |    string    |     description   |
 |  source_type  | string   |      source of variable, custom mean manual variable, component_inputs means variables comes from task node inputs parameters, component_outputs means variables comes from task node outputs parameters   |
 |  custom_type  | string   |      custom type, which is not empty when source_type is custom,  the value is input ,or textarea, or datetime, or int |
-|  source_tag   | string   |      source tag and atom info, which is not empty when source_type is  component_inputs or component_outputs  |
+|  source_tag   | string   |      source tag and standard plugin info, which is not empty when source_type is  component_inputs or component_outputs  |
 |  source_info | dict    |        source info about task node ID  |
diff --git a/docs/apidoc/en/create_task.md b/docs/apidoc/en/create_task.md
@@ -229,7 +229,7 @@ constant value, the type of value should be same with data from API[get_template
 |-----------|----------|-----------|
 |  start_event      |    dict    |      start node     |
 |  end_event      |    dict    |      end node    |
-|  activities      |    dict    |      task node（atoms or subprocess）info    |
+|  activities      |    dict    |      task node（standard plugins or subprocess）info    |
 |  gateways      |    dict    |      gateways（parallel gateway、exclusive gateway、exclusive gateway）info    |
 |  flows      |    dict    |      sequenceFlow（the line between nodes）info    |
 |  constants      |    dict    |  global variables, details are described below    |
@@ -249,5 +249,5 @@ KEY, the format is like ${key}
 |  desc      |    string    |     description   |
 |  source_type  | string   |      source of variable, custom mean manual variable, component_inputs means variables comes from task node inputs parameters, component_outputs means variables comes from task node outputs parameters   |
 |  custom_type  | string   |      custom type, which is not empty when source_type is custom,  the value is input ,or textarea, or datetime, or int |
-|  source_tag   | string   |      source tag and atom info, which is not empty when source_type is  component_inputs or component_outputs  |
+|  source_tag   | string   |      source tag and standard plugin info, which is not empty when source_type is  component_inputs or component_outputs  |
 |  source_info | dict    |        source info about task node ID  |
diff --git a/docs/apidoc/en/get_periodic_task_info.md b/docs/apidoc/en/get_periodic_task_info.md
@@ -259,7 +259,7 @@ Query periodic task detail
 |-----------|----------|-----------|
 |  start_event      |    dict    |      start node     |
 |  end_event      |    dict    |      end node    |
-|  activities      |    dict    |      task node（atoms or subprocess）info    |
+|  activities      |    dict    |      task node（standard plugins or subprocess）info    |
 |  gateways      |    dict    |      gateways（parallel gateway、exclusive gateway、exclusive gateway）info    |
 |  flows      |    dict    |      sequenceFlow（the line between nodes）info    |
 |  constants      |    dict    |  global variables, details are described below    |
@@ -279,5 +279,5 @@ KEY, the format is like ${key}
 |  desc      |    string    |     description   |
 |  source_type  | string   |      source of variable, custom mean manual variable, component_inputs means variables comes from task node inputs parameters, component_outputs means variables comes from task node outputs parameters   |
 |  custom_type  | string   |      custom type, which is not empty when source_type is custom,  the value is input ,or textarea, or datetime, or int |
-|  source_tag   | string   |      source tag and atom info, which is not empty when source_type is  component_inputs or component_outputs  |
+|  source_tag   | string   |      source tag and standard plugin info, which is not empty when source_type is  component_inputs or component_outputs  |
 |  source_info | dict    |        source info about task node ID  |
diff --git a/docs/apidoc/en/get_task_detail.md b/docs/apidoc/en/get_task_detail.md
@@ -314,7 +314,7 @@ KEY, the format is like ${key}
 |  desc      |    string    |     description   |
 |  source_type  | string   |      source of variable, custom mean manual variable, component_inputs means variables comes from task node inputs parameters, component_outputs means variables comes from task node outputs parameters   |
 |  custom_type  | string   |      custom type, which is not empty when source_type is custom,  the value is input ,or textarea, or datetime, or int |
-|  source_tag   | string   |      source tag and atom info, which is not empty when source_type is  component_inputs or component_outputs  |
+|  source_tag   | string   |      source tag and standard plugin info, which is not empty when source_type is  component_inputs or component_outputs  |
 |  source_info | dict    |        source info about task node ID  |
 
 
@@ -332,7 +332,7 @@ KEY, the format is like ${key}
 |-----------|----------|-----------|
 |  start_event      |    dict    |      start node     |
 |  end_event      |    dict    |      end node    |
-|  activities      |    dict    |      task node（atoms or subprocess）info    |
+|  activities      |    dict    |      task node（standard plugins or subprocess）info    |
 |  gateways      |    dict    |      gateways（parallel gateway、exclusive gateway、exclusive gateway）info    |
 |  flows      |    dict    |      sequenceFlow（the line between nodes）info    |
 |  constants      |    dict    |  global variables, details are described below    |

diff --git a/docs/apidoc/en/get_template_info.md b/docs/apidoc/en/get_template_info.md
@@ -226,7 +226,7 @@ Query individual flow template details of the business
 |-----------|----------|-----------|
 |  start_event      |    dict    |      start node     |
 |  end_event      |    dict    |      end node    |
-|  activities      |    dict    |      task node（atoms or subprocess）info    |
+|  activities      |    dict    |      task node（standard plugins or subprocess）info    |
 |  gateways      |    dict    |      gateways（parallel gateway、exclusive gateway、exclusive gateway）info    |
 |  flows      |    dict    |      sequenceFlow（the line between nodes）info    |
 |  constants      |    dict    |  global variables, details are described below    |
@@ -246,5 +246,5 @@ KEY, the format is like ${key}
 |  desc      |    string    |     description   |
 |  source_type  | string   |      source of variable, custom mean manual variable, component_inputs means variables comes from task node inputs parameters, component_outputs means variables comes from task node outputs parameters   |
 |  custom_type  | string   |      custom type, which is not empty when source_type is custom,  the value is input ,or textarea, or datetime, or int |
-|  source_tag   | string   |      source tag and atom info, which is not empty when source_type is  component_inputs or component_outputs  |
+|  source_tag   | string   |      source tag and standard plugin info, which is not empty when source_type is  component_inputs or component_outputs  |
 |  source_info | dict    |        source info about task node ID  |
diff --git a/docs/apidoc/en/modify_constants_for_periodic_task.md b/docs/apidoc/en/modify_constants_for_periodic_task.md
@@ -90,5 +90,5 @@ KEY, the format is like ${key}
 |  desc      |    string    |     description   |
 |  source_type  | string   |      source of variable, custom mean manual variable, component_inputs means variables comes from task node inputs parameters, component_outputs means variables comes from task node outputs parameters   |
 |  custom_type  | string   |      custom type, which is not empty when source_type is custom,  the value is input ,or textarea, or datetime, or int |
-|  source_tag   | string   |      source tag and atom info, which is not empty when source_type is  component_inputs or component_outputs  |
+|  source_tag   | string   |      source tag and standard plugin info, which is not empty when source_type is  component_inputs or component_outputs  |
 |  source_info | dict    |        source info about task node ID  |
diff --git a/docs/apidoc/zh_hans/create_periodic_task.md b/docs/apidoc/zh_hans/create_periodic_task.md
@@ -243,7 +243,7 @@
 | ------------ | ---------- | ------------------------------ |
 |  start_event      |    dict    |      开始节点信息     |
 |  end_event      |    dict    |      结束节点信息    |
-|  activities      |    dict    |      任务节点（原子和子流程）信息    |
+|  activities      |    dict    |      任务节点（标准插件和子流程）信息    |
 |  gateways      |    dict    |      网关节点（并行网关、分支网关和汇聚网关）信息    |
 |  flows      |    dict    |     顺序流（节点连线）信息    |
 |  constants      |    dict    |  全局变量信息，详情见下面    |
@@ -261,7 +261,7 @@
 |  name      |    string    |      变量名字    |
 |  index      |    int    |      变量在模板中的显示顺序    |
 |  desc      |    string    |      变量说明   |
-|  source_type      |    string    |      变量来源, 取值范围 custom: 自定义变量，component_inputs: 从原子输入参数勾选，component_outputs：从原子输出结果中勾选   |
+|  source_type      |    string    |      变量来源, 取值范围 custom: 自定义变量，component_inputs: 从标准插件输入参数勾选，component_outputs：从标准插件输出结果中勾选   |
 |  custom_type      |    string    |      source_type=custom 时有效，自定义变量类型， 取值范围 input: 输入框，textarea: 文本框，datetime: 日期时间，int: 整数|
-|  source_tag      |    string    |      source_type=component_inputs/component_outputs 时有效，变量的来源原子   |
+|  source_tag      |    string    |      source_type=component_inputs/component_outputs 时有效，变量的来源标准插件   |
 |  source_info   |   dict  |  source_type=component_inputs/component_outputs 时有效，变量的来源节点信息 |
diff --git a/docs/apidoc/zh_hans/create_task.md b/docs/apidoc/zh_hans/create_task.md
@@ -229,7 +229,7 @@
 |-----------|----------|-----------|
 |  start_event      |    dict    |      开始节点信息     |
 |  end_event      |    dict    |      结束节点信息    |
-|  activities      |    dict    |      任务节点（原子和子流程）信息    |
+|  activities      |    dict    |      任务节点（标准插件和子流程）信息    |
 |  gateways      |    dict    |      网关节点（并行网关、分支网关和汇聚网关）信息    |
 |  flows      |    dict    |     顺序流（节点连线）信息    |
 |  constants      |    dict    |  全局变量信息，详情见下面    |
@@ -247,7 +247,7 @@
 |  name      |    string    |      变量名字    |
 |  index      |    int    |      变量在模板中的显示顺序    |
 |  desc      |    string    |      变量说明   |
-|  source_type      |    string    |      变量来源, 取值范围 custom: 自定义变量，component_inputs: 从原子输入参数勾选，component_outputs：从原子输出结果中勾选   |
+|  source_type      |    string    |      变量来源, 取值范围 custom: 自定义变量，component_inputs: 从标准插件输入参数勾选，component_outputs：从标准插件输出结果中勾选   |
 |  custom_type      |    string    |      source_type=custom 时有效，自定义变量类型， 取值范围 input: 输入框，textarea: 文本框，datetime: 日期时间，int: 整数|
-|  source_tag      |    string    |      source_type=component_inputs/component_outputs 时有效，变量的来源原子   |
+|  source_tag      |    string    |      source_type=component_inputs/component_outputs 时有效，变量的来源标准插件   |
 |  source_info   |   dict  |  source_type=component_inputs/component_outputs 时有效，变量的来源节点信息 |
diff --git a/docs/apidoc/zh_hans/get_periodic_task_info.md b/docs/apidoc/zh_hans/get_periodic_task_info.md
@@ -256,7 +256,7 @@
 | ------------ | ---------- | ------------------------------ |
 |  start_event      |    dict    |      开始节点信息     |
 |  end_event      |    dict    |      结束节点信息    |
-|  activities      |    dict    |      任务节点（原子和子流程）信息    |
+|  activities      |    dict    |      任务节点（标准插件和子流程）信息    |
 |  gateways      |    dict    |      网关节点（并行网关、分支网关和汇聚网关）信息    |
 |  flows      |    dict    |     顺序流（节点连线）信息    |
 |  constants      |    dict    |  全局变量信息，详情见下面    |
@@ -274,7 +274,7 @@
 |  name      |    string    |      变量名字    |
 |  index      |    int    |      变量在模板中的显示顺序    |
 |  desc      |    string    |      变量说明   |
-|  source_type      |    string    |      变量来源, 取值范围 custom: 自定义变量，component_inputs: 从原子输入参数勾选，component_outputs：从原子输出结果中勾选   |
+|  source_type      |    string    |      变量来源, 取值范围 custom: 自定义变量，component_inputs: 从标准插件输入参数勾选，component_outputs：从标准插件输出结果中勾选   |
 |  custom_type      |    string    |      source_type=custom 时有效，自定义变量类型， 取值范围 input: 输入框，textarea: 文本框，datetime: 日期时间，int: 整数|
-|  source_tag      |    string    |      source_type=component_inputs/component_outputs 时有效，变量的来源原子   |
+|  source_tag      |    string    |      source_type=component_inputs/component_outputs 时有效，变量的来源标准插件   |
 |  source_info   |   dict  |  source_type=component_inputs/component_outputs 时有效，变量的来源节点信息 |
diff --git a/docs/apidoc/zh_hans/get_task_detail.md b/docs/apidoc/zh_hans/get_task_detail.md
@@ -331,7 +331,7 @@
 |-----------|----------|-----------|
 |  start_event      |    dict    |      开始节点信息     |
 |  end_event      |    dict    |      结束节点信息    |
-|  activities      |    dict    |      任务节点（原子和子流程）信息    |
+|  activities      |    dict    |      任务节点（标准插件和子流程）信息    |
 |  gateways      |    dict    |      网关节点（并行网关、分支网关和汇聚网关）信息    |
 |  flows      |    dict    |     顺序流（节点连线）信息    |
 |  constants      |    dict    |  全局变量信息，详情见下面    |

diff --git a/docs/apidoc/zh_hans/get_template_info.md b/docs/apidoc/zh_hans/get_template_info.md
@@ -226,7 +226,7 @@
 |-----------|----------|-----------|
 |  start_event      |    dict    |      开始节点信息     |
 |  end_event      |    dict    |      结束节点信息    |
-|  activities      |    dict    |      任务节点（原子和子流程）信息    |
+|  activities      |    dict    |      任务节点（标准插件和子流程）信息    |
 |  gateways      |    dict    |      网关节点（并行网关、分支网关和汇聚网关）信息    |
 |  flows      |    dict    |     顺序流（节点连线）信息    |
 |  constants      |    dict    |  全局变量信息，详情见下面    |
@@ -244,7 +244,7 @@
 |  name      |    string    |      变量名字    |
 |  index      |    int    |      变量在模板中的显示顺序    |
 |  desc      |    string    |      变量说明   |
-|  source_type  | string   |      变量来源, 取值范围 custom: 自定义变量，component_inputs: 从原子输入参数勾选，component_outputs：从原子输出结果中勾选   |
+|  source_type  | string   |      变量来源, 取值范围 custom: 自定义变量，component_inputs: 从标准插件输入参数勾选，component_outputs：从标准插件输出结果中勾选   |
 |  custom_type  | string   |      source_type=custom 时有效，自定义变量类型， 取值范围 input: 输入框，textarea: 文本框，datetime: 日期时间，int: 整数|
-|  source_tag   | string   |      source_type=component_inputs或component_outputs 时有效，变量的来源原子   |
+|  source_tag   | string   |      source_type=component_inputs或component_outputs 时有效，变量的来源标准插件   |
 |   source_info | dict    |  source_type=component_inputs或component_outputs 时有效，变量的来源节点信息  |
diff --git a/docs/apidoc/zh_hans/modify_constants_for_periodic_task.md b/docs/apidoc/zh_hans/modify_constants_for_periodic_task.md
@@ -87,7 +87,7 @@
 |  name      |    string    |      变量名字    |
 |  index      |    int    |      变量在模板中的显示顺序    |
 |  desc      |    string    |      变量说明   |
-|  source_type      |    string    |      变量来源, 取值范围 custom: 自定义变量，component_inputs: 从原子输入参数勾选，component_outputs：从原子输出结果中勾选   |
+|  source_type      |    string    |      变量来源, 取值范围 custom: 自定义变量，component_inputs: 从标准插件输入参数勾选，component_outputs：从标准插件输出结果中勾选   |
 |  custom_type      |    string    |      source_type=custom 时有效，自定义变量类型， 取值范围 input: 输入框，textarea: 文本框，datetime: 日期时间，int: 整数|
-|  source_tag      |    string    |      source_type=component_inputs/component_outputs 时有效，变量的来源原子   |
+|  source_tag      |    string    |      source_type=component_inputs/component_outputs 时有效，变量的来源标准插件   |
 |  source_info   |   dict  |  source_type=component_inputs/component_outputs 时有效，变量的来源节点信息 |
diff --git a/docs/install/dev_deploy.md b/docs/install/dev_deploy.md
@@ -78,13 +78,13 @@ python manage.py createcachetable django_cache
 ## 打包并收集前端静态资源
 
 1）安装依赖包  
-进入 pipeline/blueflow/，执行以下命令安装
+进入 frontend/desktop/，执行以下命令安装
 ```bash
 npm install
 ```
 
 2）本地打包
-在 pipeline/blueflow/ 目录下，继续执行以下命令打包前端静态资源
+在 frontend/desktop/ 目录下，继续执行以下命令打包前端静态资源
 ```bash
 npm run build -- --STATIC_ENV=dev
 ```
@@ -98,8 +98,8 @@ python manage.py collectstatic --noinput
 前端资源文件需要单独拷贝收集，执行如下命令
 ```bash
 rm -rf static/dev static/images
-mv pipeline/blueflow/static/dev static/
-mv pipeline/blueflow/static/images static/
+mv frontend/desktop/static/dev static/
+mv frontend/desktop/static/images static/
 ```