You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by he...@apache.org on 2021/12/12 04:53:03 UTC
[incubator-inlong-website] branch master updated: [INLONG-1648] user manual use corresponding images (#224)
This is an automated email from the ASF dual-hosted git repository.
healchow pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 8c8a0ff [INLONG-1648] user manual use corresponding images (#224)
8c8a0ff is described below
commit 8c8a0ff98010dbaff5862be64ce82b769c735fad
Author: dockerzhang <do...@apache.org>
AuthorDate: Sun Dec 12 12:52:59 2021 +0800
[INLONG-1648] user manual use corresponding images (#224)
Co-authored-by: dockerzhang <do...@tencent.com>
---
docs/administration/approval_management.md | 6 +-
docs/administration/img/approval-access.png | Bin 0 -> 27573 bytes
docs/administration/img/approval-consumption.png | Bin 0 -> 25209 bytes
docs/administration/img/approval-list.png | Bin 0 -> 27441 bytes
docs/administration/img/user-create.png | Bin 0 -> 7888 bytes
docs/administration/img/user-delete.png | Bin 0 -> 20649 bytes
docs/administration/img/user-edit.png | Bin 0 -> 13931 bytes
docs/administration/user_management.md | 13 +-
docs/user_guide/img/application-detail.png | Bin 0 -> 23480 bytes
docs/user_guide/img/consumer-info.png | Bin 0 -> 14451 bytes
docs/user_guide/img/create-group.png | Bin 0 -> 20044 bytes
docs/user_guide/img/create-stream.png | Bin 0 -> 12220 bytes
docs/user_guide/img/data-info.png | Bin 0 -> 14764 bytes
docs/user_guide/img/group-information.png | Bin 0 -> 17823 bytes
docs/user_guide/img/hive-info.png | Bin 0 -> 22918 bytes
docs/user_guide/img/my-application.png | Bin 0 -> 21943 bytes
docs/user_guide/img/user-login.png | Bin 0 -> 6554 bytes
docs/user_guide/user_manual.md | 183 +++++++--------------
.../current/administration/approval_management.md | 6 +-
.../current/administration/img/approval-access.png | Bin 0 -> 24932 bytes
.../administration/img/approval-consumption.png | Bin 0 -> 28046 bytes
.../current/administration/img/approval-list.png | Bin 0 -> 27032 bytes
.../current/administration/img/user-create.png | Bin 0 -> 7996 bytes
.../current/administration/img/user-delete.png | Bin 0 -> 17216 bytes
.../current/administration/img/user-edit.png | Bin 0 -> 16850 bytes
.../current/administration/user_management.md | 14 +-
.../current/user_guide/img/application-detail.png | Bin 0 -> 23949 bytes
.../current/user_guide/img/consumer-info.png | Bin 0 -> 12585 bytes
.../current/user_guide/img/create-group.png | Bin 0 -> 23548 bytes
.../current/user_guide/img/create-stream.png | Bin 0 -> 11987 bytes
.../current/user_guide/img/data-info.png | Bin 0 -> 15250 bytes
.../current/user_guide/img/group-information.png | Bin 0 -> 17309 bytes
.../current/user_guide/img/hive-info.png | Bin 0 -> 22663 bytes
.../current/user_guide/img/my-application.png | Bin 0 -> 21043 bytes
.../current/user_guide/img/user-login.png | Bin 0 -> 5906 bytes
.../current/user_guide/user_manual.md | 150 ++++++-----------
36 files changed, 120 insertions(+), 252 deletions(-)
diff --git a/docs/administration/approval_management.md b/docs/administration/approval_management.md
index 2eb80ec..6bb28e9 100644
--- a/docs/administration/approval_management.md
+++ b/docs/administration/approval_management.md
@@ -6,7 +6,7 @@ sidebar_position: 2
As a data access officer and system member with approval authority, have the responsibility for data access or
consumption approval.
-
+
#### Data Access Approval
@@ -15,7 +15,7 @@ New data access approval: currently it is a first-level approval, which is appro
The system administrator will review whether the access process meets the access requirements based on the data access
business information.
-
+
#### New data consumption approval
@@ -25,4 +25,4 @@ business.
Business approval: The person in charge of the data access business judges whether the consumption meets the business
requirements according to the access information:
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/docs/administration/img/approval-access.png b/docs/administration/img/approval-access.png
new file mode 100644
index 0000000..a0ce096
Binary files /dev/null and b/docs/administration/img/approval-access.png differ
diff --git a/docs/administration/img/approval-consumption.png b/docs/administration/img/approval-consumption.png
new file mode 100644
index 0000000..4bf13ac
Binary files /dev/null and b/docs/administration/img/approval-consumption.png differ
diff --git a/docs/administration/img/approval-list.png b/docs/administration/img/approval-list.png
new file mode 100644
index 0000000..0038cc8
Binary files /dev/null and b/docs/administration/img/approval-list.png differ
diff --git a/docs/administration/img/user-create.png b/docs/administration/img/user-create.png
new file mode 100644
index 0000000..0ac2beb
Binary files /dev/null and b/docs/administration/img/user-create.png differ
diff --git a/docs/administration/img/user-delete.png b/docs/administration/img/user-delete.png
new file mode 100644
index 0000000..028c6ed
Binary files /dev/null and b/docs/administration/img/user-delete.png differ
diff --git a/docs/administration/img/user-edit.png b/docs/administration/img/user-edit.png
new file mode 100644
index 0000000..048b5e5
Binary files /dev/null and b/docs/administration/img/user-edit.png differ
diff --git a/docs/administration/user_management.md b/docs/administration/user_management.md
index 450b47f..830f6b3 100644
--- a/docs/administration/user_management.md
+++ b/docs/administration/user_management.md
@@ -9,7 +9,7 @@ Only users with the role of system administrator can use this function. They can
Users with system administrator rights can create new user accounts
-
+
- Account types: Ordinary users (with data access and data consumption permissions, but without data access approval and
account management permissions); system administrators (with data access and data consumption permissions, data access
@@ -17,27 +17,22 @@ Users with system administrator rights can create new user accounts
- username: username for login
- user password:
-Effective duration: the account can be used in the system
- 
### Delete user
The system administrator can delete the account of the created user. After the deletion, the account will stop using:
-
+
### User Edit
The system administrator can modify the created account:
-
-
-The system administrator can modify the account type and effective duration to proceed:
-
-
+
### Change password
The user can modify the account password, click [Modify Password], enter the old password and the new password, after
confirmation, the new password of this account will take effect:
-
+
diff --git a/docs/user_guide/img/application-detail.png b/docs/user_guide/img/application-detail.png
new file mode 100644
index 0000000..69d71ba
Binary files /dev/null and b/docs/user_guide/img/application-detail.png differ
diff --git a/docs/user_guide/img/consumer-info.png b/docs/user_guide/img/consumer-info.png
new file mode 100644
index 0000000..99009fd
Binary files /dev/null and b/docs/user_guide/img/consumer-info.png differ
diff --git a/docs/user_guide/img/create-group.png b/docs/user_guide/img/create-group.png
new file mode 100644
index 0000000..eb0655b
Binary files /dev/null and b/docs/user_guide/img/create-group.png differ
diff --git a/docs/user_guide/img/create-stream.png b/docs/user_guide/img/create-stream.png
new file mode 100644
index 0000000..7779b6b
Binary files /dev/null and b/docs/user_guide/img/create-stream.png differ
diff --git a/docs/user_guide/img/data-info.png b/docs/user_guide/img/data-info.png
new file mode 100644
index 0000000..1630063
Binary files /dev/null and b/docs/user_guide/img/data-info.png differ
diff --git a/docs/user_guide/img/group-information.png b/docs/user_guide/img/group-information.png
new file mode 100644
index 0000000..b534c5b
Binary files /dev/null and b/docs/user_guide/img/group-information.png differ
diff --git a/docs/user_guide/img/hive-info.png b/docs/user_guide/img/hive-info.png
new file mode 100644
index 0000000..1f093a8
Binary files /dev/null and b/docs/user_guide/img/hive-info.png differ
diff --git a/docs/user_guide/img/my-application.png b/docs/user_guide/img/my-application.png
new file mode 100644
index 0000000..e075ad4
Binary files /dev/null and b/docs/user_guide/img/my-application.png differ
diff --git a/docs/user_guide/img/user-login.png b/docs/user_guide/img/user-login.png
new file mode 100644
index 0000000..91e7647
Binary files /dev/null and b/docs/user_guide/img/user-login.png differ
diff --git a/docs/user_guide/user_manual.md b/docs/user_guide/user_manual.md
index fb28663..2a8cd55 100644
--- a/docs/user_guide/user_manual.md
+++ b/docs/user_guide/user_manual.md
@@ -3,108 +3,98 @@ title: Usage Manual
sidebar_position: 1
---
-## 1 User login
+## User Login
-Requires the user to enter the account name and password of the system.
+Requires the user to enter the account name and password of the system, default account is `admin inlong`.
-
+
-## 2 Data access
+## Data Access
The data access module displays a list of all tasks connected to the system within the current user authority, and can
view, edit, update and delete the details of these tasks.
-Click [Data Access], there are two steps to fill in data access information: business information, data stream.
+Click [Create], there are two steps to fill in data access information: Group information, data stream.
-
+
-### 2.1 Business Information
+### Data Stream Group Information
-#### 2.1.1 Business Information
+
-You are required to fill in basic business information for access tasks.
+#### Access Requirements
-
+Access requirements require users to choose message middleware: high throughput (TUBE) or High reliability (PULSAR):
-- Business English ID: Unified lowercase English name, please try to include the product name and concise
- specifications, such as pay_base
-- Business Chinese name: Chinese description of the business, easy to use and retrieve, up to 128 characters
-- Business responsible person: at least 2 people, the business responsible person can view and modify business
- information, add and modify all access configuration items
-- Business introduction: Cut SMS to introduce the business background and application of this access task:
-
-#### 2.1.2 Access requirements
+high throughput (TUBE): high-throughput message transmission component, suitable for log message transmission.
+high reliability (PULSAR): high-reliability message transmission component, suitable for billing transmission.
-Access requirements require users to choose message middleware: high throughput (TUBE):
+#### Group Information
-
+You are required to fill in basic data stream group information for access tasks.
-High-throughput-Tube: high-throughput message transmission component, suitable for log message transmission.
+- Group Name: Unified lowercase English name, please try to include the product name and concise
+ specifications, such as pay_base
+- Group Label: the label of the group, easy to use and retrieve, up to 128 characters
+- Group responsible person: at least 1 people, the group responsible person can view and modify group
+ information, add and modify all access configuration items
+- Group introduction: Cut SMS to introduce the group background and application of this access task:
-#### 2.1.3 Access scale
+#### Access Scale
The scale of access requires users to judge the scale of access data in advance, to allocate computing and storage
resources later.
-
-
-### 2.2 Data stream
+### Data Stream
-Click [Next] to enter the data flow information filling step. There are four modules for data flow information filling:
+Click [Next] to enter the data stream information filling step. There are four modules for data stream information filling:
basic information, data source, data information, and data stream.
-In the data flow process, you can click [New Data Stream] to create a new data stream page:
+In the data stream process, you can click [Create] to create a new data stream:
-
+
-#### 2.2.1 Basic information
+#### Basic Information
You are required to fill in the basic information of the data stream in the access task:
-
-
-- InLong stream id: The prefix is automatically generated according to the product/project, which is unique in a
- specific business group and is consistent with the stream id in the data source and the storage table
+- Data stream id: The prefix is automatically generated according to the product/project, which is unique in a
+ specific group and is consistent with the stream id in the data source and the storage table
- Data stream name: interface information description, the length is limited to 64 characters (32 Chinese characters)
- Data stream owner: The data stream owner can view and modify data stream information, add and modify all access
configuration items
-- Introduction to data flow: simple text introduction to data flow
+- Introduction to data stream: simple text introduction to data stream
-#### 2.2.2 Data source
+#### Data Sources
You are required to select the source of the data stream.
-Currently, three methods of file and independent push are supported, and the detailed information of the data source can
+Currently, two methods of file and independent push are supported, and the detailed information of the data source can
be supplemented in the advanced options.
- File: The business data is in the file, and the business machine deploys InLong Agent, which is read according to
customized policy rules
- Autonomous push: Push data to the messaging middleware through the SDK
-
-
-#### 2.2.3 Data Information
+#### Data Information
You are required to fill in the data-related information in the data stream.
-
+
- Data Format
-- Data encoding: If the data source contains Chinese, you need choose UTF-8 or GBK, otherwise the encoding format is
- incorrect and garbled characters after storage
-- Source field separator: the format of data sent to MQ
-- Source data field: attributes with different meanings divided by a certain format in MQ
+- Data encoding
+- Source field separator
+- Source data field
-#### 2.2.4 Data storage
+#### Data Storage
-You are required to select the final flow direction of this task, this part is not currently supports both hive storage
+You are required to select the final flow direction of this data stream, this part is not currently supports both hive storage
and autonomous push.
-
-
Add HIVE storage:
-
+
- Target database: hive database name (prepared to create in advance)
- Target table: hive table name
@@ -115,103 +105,48 @@ Add HIVE storage:
- HDFS url: Hive bottom HDFS connection
- JDBC url: jdbc url of hive server
- Field related information: source field name, source field type, HIVE field name, HIVE field type, field description,
- and support deletion and addition-
-
-## 3 Access details
-
-### 3.1 Execution log
-
-When the status of the data access task is "approved successfully" or "configuration failed", the "execution log"
-function can be used to allow users to view the progress and details of the task.
+ and support deletion and addition
-
+## My Application
-Click [Execution Log] to display the details of the task execution log in a pop-up window.
-
-
-
-The execution log will display the task type, execution result, execution log content, end time, and the end time of the
-execution of the access process. If the execution fails, you can "restart" the task and execute it again.
-
-### 3.2 Task details
-
-The business person in charge/following person can view the access details of the task, and can modify and update part
-of the information under the status of [Waiting Applying], [Configuration Successful], and [Configuration Failed].
-
-There are three modules in the access task details: business information, data stream and data storage.
-
-#### 3.2.1 Business Information
-
-Display the basic business information in the access task, click [Edit] to modify part of the content
-
-
-
-#### 3.2.2 Data stream
+The approval management function module currently includes my application and my approval, and all tasks of data access
+and consumption application approval in the management system.
-Display the basic information of the data flow under the access task, click [New Data Flow] to create a new data flow
-information
+
-
+Display the current task list submitted by the applicant for data access and consumption in the system, click [Details]
+to view the current basic information and approval process of the task.
-#### 3.2.3 Data Storage
+#### Application Data Access Details
-Display the basic information of the data flow in the access task, select different flow types through the drop-down
-box, and click [New Flow Configuration] to create a new data storage.
+
-
+Data access task detailed display The current basic information of the application task includes: applicant-related
+information, basic information about application access, and current approval process nodes.
-## 4 Data consumption
+## Data Consumption
Data consumption currently does not support direct consumption access to data, and data can be consumed normally after
the approval process.
-Click [New Consumption] to enter the data consumption process, and you need to fill in information related to
+Click [Create] to enter the data consumption process, and you need to fill in information related to
consumption.
-
-
-### 4.1 Consumer Information
+### Consumer Information
-Applicants need to gradually fill in the basic consumer business information related to data consumption applications in
+Applicants need to gradually fill in the basic consumer data stream group information related to data consumption applications in
the information filling module
-
+
-- Consumer group name: The prefix is automatically generated according to the product/project. The brief name of the
+- Consumer group name: The brief name of the
consumer must be composed of lowercase letters, numbers, and underscores. The final approval will assign the consumer
name based on the abbreviation splicing
- Consumer Responsible Person: At least 2 persons are required to choose the responsible person; the responsible person
can view and modify the consumption information
-- Consumer target business group id: you need to select the business group id of the consumer data, you can click [Query] and
- select the appropriate business group id in the pop-up window
- 
+- Consumer target data stream group id: you need to select the group id of the consumer data, you can click [Query] and
+ select the appropriate group id in the pop-up window
- Data usage: select data usage usage
- Data usage description: The applicant needs to briefly explain the items used and the purpose of the data according to
their own consumption scenarios After completing the information, click [Submit], and the data consumption process
- will be formally submitted to the approver before it will take effect.
-
-## 5 Approval management
-
-The approval management function module currently includes my application and my approval, and all tasks of data access
-and consumption application approval in the management system.
-
-### 5.1 My application
-
-Display the current task list submitted by the applicant for data access and consumption in the system, click [Details]
-to view the current basic information and approval process of the task.
-
-
-
-#### 5.1.1 Data access details
-
-Data access task detailed display The current basic information of the application task includes: applicant-related
-information, basic information about application access, and current approval process nodes.
-
-
-
-#### 5.1.2 Data consumption details
-
-Data consumption task details display basic information of current application tasks including: applicant information,
-basic consumption information, and current approval process nodes.
-
-
\ No newline at end of file
+ will be formally submitted to the approver before it will take effect.
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/approval_management.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/approval_management.md
index 227923c..f0cd274 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/approval_management.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/approval_management.md
@@ -5,7 +5,7 @@ sidebar_position: 2
作为具有审批权限的数据接入员和系统成员，具备对数据接入或者消费审批职责：
-
+
#### 数据接入审批
@@ -13,7 +13,7 @@ sidebar_position: 2
系统管理员将根据数据接入业务信息，审核此次接入流程是否符合接入要求：
-
+
#### 新建数据消费审批
@@ -21,4 +21,4 @@ sidebar_position: 2
业务审批：由数据接入业务负责人根据接入信息判断此消费是否符合业务要求：
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/approval-access.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/approval-access.png
new file mode 100644
index 0000000..2f2f1e1
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/approval-access.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/approval-consumption.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/approval-consumption.png
new file mode 100644
index 0000000..876c5b1
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/approval-consumption.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/approval-list.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/approval-list.png
new file mode 100644
index 0000000..2d0dc9a
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/approval-list.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/user-create.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/user-create.png
new file mode 100644
index 0000000..94e8906
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/user-create.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/user-delete.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/user-delete.png
new file mode 100644
index 0000000..634582c
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/user-delete.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/user-edit.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/user-edit.png
new file mode 100644
index 0000000..377302e
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/user-edit.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/user_management.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/user_management.md
index f3e46d9..c9fa82a 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/user_management.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/user_management.md
@@ -9,33 +9,27 @@ sidebar_position: 1
具有系统管理员权限用户，可以进行创建新用户账号：
-
+
- 账号类型： 普通用户（具有数据接入和数据消费权限，不具有数据接入审批和账号管理权限）；系统管理员（具有数据接入和数据消费权限、数据接入审批和管理账号的权限）
- 用户名称：用户登录账号ID
- 用户密码：用户登录密码
- 有效时长：该账号可在系统使用期限
-
-
### 删除用户
系统管理员可以对已创建的用户进行账户删除，删除后此账号将停止使用：
-
+
### 修改用户
系统管理员可以修改已创建的账号：
-
-
-系统管理员可以修改账号类型和有效时长进行：
-
-
+
### 更改密码
用户可以修改账号密码，点击【修改密码】，输入旧密码和新密码，确认后此账号新密码将生效：
-
+
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/application-detail.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/application-detail.png
new file mode 100644
index 0000000..5f78755
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/application-detail.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/consumer-info.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/consumer-info.png
new file mode 100644
index 0000000..bec5624
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/consumer-info.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/create-group.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/create-group.png
new file mode 100644
index 0000000..dadd1df
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/create-group.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/create-stream.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/create-stream.png
new file mode 100644
index 0000000..1c45166
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/create-stream.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/data-info.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/data-info.png
new file mode 100644
index 0000000..30348dd
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/data-info.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/group-information.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/group-information.png
new file mode 100644
index 0000000..ac0bd32
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/group-information.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/hive-info.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/hive-info.png
new file mode 100644
index 0000000..2fc57c1
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/hive-info.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/my-application.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/my-application.png
new file mode 100644
index 0000000..70ed126
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/my-application.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/user-login.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/user-login.png
new file mode 100644
index 0000000..a6090dd
Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/user-login.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/user_manual.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/user_manual.md
index 32dd907..ae56495 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/user_manual.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/user_manual.md
@@ -3,95 +3,86 @@ title: 使用手册
sidebar_position: 1
---
-## 1 用户登录
+## 用户登录
-需系统使用用户输入账号名称和密码。
+需系统使用用户输入账号名称和密码，默认账号是`admin inlong`。
-
+
-## 2 数据接入
+## 数据接入
数据接入模块展示目前用户权限内接入系统所有任务列表，可以对这些任务详情查看、编辑更新和删除操作。
-点击【数据接入】接入流程，数据接入信息填写有两个步骤：业务信息、数据流。
+点击【新建接入】接入流程，数据接入信息填写有两个步骤：Group 信息、数据流。
-
+
-### 2.1 业务信息
+### 数据流Group 信息
-#### 2.1.1 业务信息
+
-需要用户对接入任务填写基础业务信息。
+#### 接入要求
-
+接入要求需要用户进行选择消息中间件：高吞吐（TUBE）或者高可靠（PULSAR）：
-- 业务ID：统一小写英文名称，请尽量包含产品名和简洁规范，如pay_base
-- 业务中文名称：业务的中文描述，便于使用与检索，最多128个字
-- 业务责任人：至少2人，业务责任人可查看、修改业务信息，新增和修改所有接入配置项
-- 业务介绍：剪短信对此次接入任务进行业务背景和应用介绍：
-
-#### 2.1.2 接入要求
+高吞吐—Tube ：高吞吐消息传输组件，适用于日志类的消息传递。
+高可靠—Pulsar ：高可靠消息传输组件，适用于计费等场景。
-接入要求需要用户进行选择消息中间件：高吞吐（TUBE）：
+#### Group 信息
-
+需要用户对接入任务填写基础数据流Group 信息。
-高吞吐—Tube ：高吞吐消息传输组件，适用于日志类的消息传递。
+- Group 英文名称：统一小写英文名称，请尽量包含产品名和简洁规范，如pay_base
+- Group 中文名称：Group 的中文描述，便于使用与检索，最多128个字
+- Group 责任人：至少1人，Group 责任人可查看、修改Group 信息，新增和修改所有接入配置项
+- Group 介绍：简短对此次接入任务Group 背景和应用进行介绍：
-#### 2.1.3 接入规模
+#### 接入规模
接入规模需要用户预先针对接入数据进行规模判断，以便后续分配计算和存储资源。
-
-
-### 2.2 数据流
+### 数据流
点击【下一步】进入到数据流信息填写步骤，数据流信息填写有四个模块：基础信息、数据来源、数据信息、数据流向。
-在数据流流程中可以点击【新建数据流】，创建一个新的数据流信息填写页面：
+在数据流流程中可以点击【新建】，创建一个新的数据流信息填写页面：
-
+
-#### 2.2.1 基础信息
+#### 基础信息
需用户对该接入任务中数据流的基础信息进行填写：
-
-
- 数据流ID：前缀根据产品/项目自动生成，这在某个具体的接入中是唯一的，与数据源和入库的表中的数据流ID保持一致
- 数据流名称：接口信息说明，长度限制为64个英文字符（对应32个中文字符）
- 数据流责任人：数据流责任人可查看、修改数据流信息，新增和修改所有接入配置项
- 数据流介绍：数据流简单文本介绍
-#### 2.2.2 数据来源
+#### 数据来源
-需用户选择该数据流的消息来源，目前支持文件、自主推送三种方式，并且可以在高级选项中补充该数据来源详细信息：
+需用户选择该数据流的消息来源，目前支持文件、自主推送两种方式，并且可以在高级选项中补充该数据来源详细信息：
-- 文件：业务数据以文件形式存放，业务机器部署 InLong Agent，根据定制的策略规则进行读取
+- 文件：采集数据以文件形式存放，采集机器部署 InLong Agent，根据定制的策略规则进行读取
- 自主推送：通过 SDK 向消息中间件推送数据
- 
-
-#### 2.2.3 数据信息
+#### 数据信息
需用户填写该数据流中数据相关信息：
-
+
- 数据格式：数据来源格式，是普通文本类型，或者KV键值对数据
-- 数据编码：如数据源含中文，需要选UTF-8或GBK，否则编码格式不对，入库后会乱码
-- 源字段分隔符：数据发送到 MQ 里的格式
-- 源数据字段：数据在 MQ 里按某种格式划分的不同含义的属性
+- 数据编码
+- 源字段分隔符
+- 源数据字段
-#### 2.2.4 数据流向
+#### 数据流向
需用户对此任务的流向终流向进行选择，此部分为非必填项，目前支持Hive和自主推送两种：
-
-
HIVE流向：
-
+
- 目标库：hive数据库名（需要提前准备创建好）
- 目标表：hive表名
@@ -103,81 +94,34 @@ HIVE流向：
- JDBC url：hiveserver 的jdbcurl
- 字段相关信息： 源字段名、源字段类型、HIVE字段名、HIVE字段类型、字段描述，并支持删除和新增字段
-## 3 接入详情
-
-### 3.1 执行日志
-
-当数据接入任务状态为”批准成功“和”配置失败“状态，可通过”执行日志“功能，以便用户查看任务执行进程进程和详情：
-
-
-
-点击【执行日志】将以弹窗形式展示该任务执行日志详情：
-
-
-
-执行日志中将展示该接入流程执行中任务类型、执行结果、执行日志内容、结束时间、如果执行失败可以”重启“该任务再次执行。
-
-### 3.2 任务详情
-
-业务负责人/关注人可以查看该任务接入详情，并在【待提交】、【配置成功】、【配置失败】状态下可对部分信息进行修改更新接入任务详情中具有业务信息、数据流、流向三个模块。
-
-#### 3.2.1 业务信息
-
-展示接入任务中基础业务信息，点击【编辑】可对部分内容进行修改更改：
-
-
+## 我的申请
-#### 3.2.2 数据流
+审批管理功能模块目前包含了我的申请和我的审批，管理系统中数据接入和数据消费申请审批全部任务。
-展示该接入任务下数据流基础信息，点击【新建数据流】可新建一条数据流信息：
+
-
+展示目前申请人在系统中数据接入、消费提交的任务列表，点击【详情】可以查看目前该任务基础信和审批进程：
-#### 3.2.3 流向
+#### 申请数据接入详情
-展示该接入任务中数据流向基础信息，通过通过下拉框选择不同流向类型，点击【新建流向配置】可新建一条数据流向：
+
-
+数据接入任务详细展示目前该申请任务基础信息包括：申请人相关信息、申请接入基础信息，以及目前审批进程节点：
-## 4 数据消费
+## 数据消费
数据消费目前不支持直接消费接入数据，需走数据审批流程后方可正常消费数据； 点击【新建消费】，进入数据消费流程，需要对消费信息相关信息进行填写：
-
-### 4.1 消费信息
+### 消费信息
-申请人需在该信息填写模块中逐步填写数据消费申请相关基础消费业务信息：
+申请人需在该信息填写模块中逐步填写数据消费申请相关基础消费数据流Group 信息：
-
+
-- 消费组名称：前缀根据BG/产品/项目自动生成，消费者的简要名称，必须是小写字母、数字、下划线组成，最后审批会根据简称拼接分配出消费者名称
+- 消费组名称：消费者的简要名称，必须是小写字母、数字、下划线组成，最后审批会根据简称拼接分配出消费者名称
- 消费责任人：自行选择责任人，必须至少2人；责任人可查看、修改消费信息
-- 消费目标业务ID：需要选择消费数据的业务ID，可以点击【查询】后，在弹窗页面中选择合适的业务ID，如下图所示：
+- 消费目标数据流Group ID：需要选择消费数据的数据流Group ID，可以点击【查询】后，在弹窗页面中选择合适的数据流Group ID，如下图所示：
- 数据用途：选择数据使用用途
- 数据用途说明：需申请人根据自身消费场景，简要说明使用的项目和数据的用途
-信息填完完成后，点击【提交】后，会将次数据消费流程正式提交待审批人审批后方可生效。
-
-
-
-## 5 审批管理
-
-审批管理功能模块目前包含了我的申请和我的审批，管理系统中数据接入和数据消费申请审批全部任务。
-
-### 5.1 我的申请
-
-展示目前申请人在系统中数据接入、消费提交的任务列表，点击【详情】可以查看目前该任务基础信和审批进程：
-
-
-
-#### 5.1.1 数据接入详情
-
-数据接入任务详细展示目前该申请任务基础信息包括：申请人相关信息、申请接入基础信息，以及目前审批进程节点：
-
-
-
-#### 5.1.2 数据消费详情
-
-数据消费任务详情展示目前申请任务基础信息包括：申请人信息、基础消费信息，以及目前审批进程节点：
-
-
\ No newline at end of file
+信息填完完成后，点击【提交】后，会将次数据消费流程正式提交待审批人审批后方可生效。
\ No newline at end of file