This is an automated email from the ASF dual-hosted git repository.
dockerzhang 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 c83649008 [INLONG-3682] Optimize classification for the sort and usage
manual guide (#348)
c83649008 is described below
commit c83649008f72d9fb332c416aa3c54a9b565e50b6
Author: dockerzhang <[email protected]>
AuthorDate: Thu Apr 14 10:41:50 2022 +0800
[INLONG-3682] Optimize classification for the sort and usage manual guide
(#348)
---
docs/deployment/bare_metal.md | 2 +-
docs/design_and_concept/basic_concept.md | 17 --------------
.../design_and_concept/how_to_write_plugin_sort.md | 18 +++++++++++++++
docs/user_guide/command_line_tools.md | 24 ++++++++++----------
.../{user_manual.md => dashboard_usage.md} | 2 +-
docs/user_guide/img/user-login.png | Bin 6554 -> 24761 bytes
.../current/deployment/bare_metal.md | 2 +-
.../current/design_and_concept/basic_concept.md | 25 +++++++++++----------
...sink_in_sort.md => how_to_write_plugin_sort.md} | 0
.../current/user_guide/command_line_tools.md | 24 ++++++++++----------
.../{user_manual.md => dashboard_usage.md} | 2 +-
.../current/user_guide/img/user-login.png | Bin 5906 -> 20621 bytes
12 files changed, 59 insertions(+), 57 deletions(-)
diff --git a/docs/deployment/bare_metal.md b/docs/deployment/bare_metal.md
index eacf0b0f0..221516eaa 100644
--- a/docs/deployment/bare_metal.md
+++ b/docs/deployment/bare_metal.md
@@ -25,4 +25,4 @@ You can get binary package from [Download
Page](https://inlong.apache.org/downlo
| 5 | inlong-dashboard | Nginx or Docker | [InLong
Dashboard](modules/dashboard/quick_start.md) | |
## Create Data Stream
-After the InLong cluster deployed successfully, you can create a data stream
refer to the [user manual](user_guide/user_manual.md) to start using.
\ No newline at end of file
+After the InLong cluster deployed successfully, you can create a data stream
refer to the [Dashboard Usage Guide](user_guide/dashboard_usage.md) to start
using.
\ No newline at end of file
diff --git a/docs/design_and_concept/basic_concept.md
b/docs/design_and_concept/basic_concept.md
deleted file mode 100644
index d8b33a271..000000000
--- a/docs/design_and_concept/basic_concept.md
+++ /dev/null
@@ -1,17 +0,0 @@
----
-title: Basic Concept
-sidebar_position: 1
----
-
-| Name | Description | Other |
-|------------| ---- | ---- |
-| Group | Data Streams Group, it contains multiple data streams, and one
Group represents one data ingestion. | Group has attributes such as ID and
Name. |
-| Stream | Data Stream, a stream has a specific flow direction. | Stream
has attributes such as ID, Name, and data fields. |
-| InLongMsg | InLong data format, if you consume message directly from the
message queue, you need to perform `InLongMsg` parsing first. |
-| Agent | Represents various collection capabilities. | It contains File
Agent, SQL Agent, Binlog Agent, etc. |
-| DataProxy | Forward received data to different message queues. | Supports
data transmission blocking, placing retransmission. |
-| Sort | Data stream sorting | Sort-flink based on Flink,
sort-standalone for local sorting. |
-| TubeMQ | InLong's self-developed message queuing service | It can also
be called Tube, with low-cost, high-performance features. |
-| Pulsar | [Apache Pulsar](https://pulsar.apache.org/), a
high-performance, high-consistency message queue service |
-| Hive | [Apache Hive](https://hive.apache.org/), a data warehouse built
on the Hadoop architecture |
-| ClickHouse | [ClickHouse](https://clickhouse.com/), a high performance
columnar OLAP database | |
\ No newline at end of file
diff --git a/docs/design_and_concept/how_to_write_plugin_sort.md
b/docs/design_and_concept/how_to_write_plugin_sort.md
new file mode 100644
index 000000000..7f7e9a7bf
--- /dev/null
+++ b/docs/design_and_concept/how_to_write_plugin_sort.md
@@ -0,0 +1,18 @@
+---
+title: Basic Concept
+sidebar_position: 1
+---
+
+| Name | Description
| Other
|
+|------------|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|
+| Group | Data Streams Group, it contains multiple data streams, and one
Group represents one data ingestion. | Group has
attributes such as ID and Name. |
+| Stream | Data Stream, a stream has a specific flow direction.
| Stream has
attributes such as ID, Name, and data fields. |
+| Node | Data Node, including `Extract Node` and `Load Node`, stands
for the data source and sink types separately. |
|
+| InLongMsg | InLong data format, if you consume message directly from the
message queue, you need to perform `InLongMsg` parsing first. |
|
+| Agent | Represents various collection capabilities.
| It contains File
Agent, SQL Agent, Binlog Agent, etc. |
+| DataProxy | Forward received data to different message queues.
| Supports data
transmission blocking, placing retransmission. |
+| Sort | Data stream sorting
| Sort-flink based
on Flink, sort-standalone for local sorting. |
+| TubeMQ | InLong's self-developed message queuing service
| It can also be
called Tube, with low-cost, high-performance features. |
+| Pulsar | [Apache Pulsar](https://pulsar.apache.org/), a
high-performance, high-consistency message queue service |
|
+| Hive | [Apache Hive](https://hive.apache.org/), a data warehouse built
on the Hadoop architecture |
|
+| ClickHouse | [ClickHouse](https://clickhouse.com/), a high performance
columnar OLAP database |
|
\ No newline at end of file
diff --git a/docs/user_guide/command_line_tools.md
b/docs/user_guide/command_line_tools.md
index 1ff44c8f2..9275eb699 100644
--- a/docs/user_guide/command_line_tools.md
+++ b/docs/user_guide/command_line_tools.md
@@ -3,19 +3,8 @@ title: Command-line Tools
sidebar_position: 2
---
-## Configuration
-
-Go to the `inlong-manager` directory , modify the following configurations of
the `conf/application.properties` file.
-
-```
-server.host=127.0.0.1
-server.port=8080
-default.admin.user=admin
-default.admin.password=inlong
-```
-
## Overview
-
+In addition to [InLong Dashboard](user_guide/dashboard_usage.md), you can view
and create data groups and streams through command-line tools.
```
Usage: managerctl [options] [command] [command options]
Options:
@@ -34,6 +23,17 @@ Usage: managerctl [options] [command] [command options]
The current command line tool supports three commands of `list` , `describe` ,
and `create`.
+## Configuration
+
+Go to the `inlong-manager` directory , modify the following configurations of
the `conf/application.properties` file.
+
+```
+server.host=127.0.0.1
+server.port=8080
+default.admin.user=admin
+default.admin.password=inlong
+```
+
## List
```
diff --git a/docs/user_guide/user_manual.md b/docs/user_guide/dashboard_usage.md
similarity index 99%
rename from docs/user_guide/user_manual.md
rename to docs/user_guide/dashboard_usage.md
index a3cc5750f..02e087ea7 100644
--- a/docs/user_guide/user_manual.md
+++ b/docs/user_guide/dashboard_usage.md
@@ -1,5 +1,5 @@
---
-title: Usage Manual
+title: Dashboard Usage Guide
sidebar_position: 1
---
diff --git a/docs/user_guide/img/user-login.png
b/docs/user_guide/img/user-login.png
index 91e7647fd..35fa0fd4d 100644
Binary files a/docs/user_guide/img/user-login.png and
b/docs/user_guide/img/user-login.png differ
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/bare_metal.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/bare_metal.md
index b74388bcb..1dfdd7b25 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/bare_metal.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/bare_metal.md
@@ -25,5 +25,5 @@ InLong 当前支持以下消息队列，根据使用情况**选择其一**即可
| 5 | inlong-dashboard | Nginx 或者 Docker | [InLong
Dashboard](modules/dashboard/quick_start.md) | |
## 创建数据流
-InLong 集群部署成功后，你可以参考[用户手册](user_guide/user_manual.md)创建一个数据流开始使用。
+InLong 集群部署成功后，你可以参考[Dashboard 使用指引](user_guide/dashboard_usage.md)创建一个数据流开始使用。
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/design_and_concept/basic_concept.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/design_and_concept/basic_concept.md
index e54e43594..b3a7e3a6f 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/design_and_concept/basic_concept.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/design_and_concept/basic_concept.md
@@ -3,15 +3,16 @@ title: 基本概念
sidebar_position: 1
---
-| Name | Description | Other |
-| ---- |----------------------------------------------------------| ---- |
-| Group | 数据流组，包含多个数据流，一个Group 代表一个数据接入 | Group
有ID、Name 等属性 |
-| Stream | 数据流，一个数据流有具体的流向 | Stream
有ID、Name、数据字段等属性 |
-| InLongMsg | InLong 数据格式，如果从消息队列中直接消费，需要先进行`InLongMsg` 解析 |
-| Agent | 代表各种采集能力 |
包含文件Agent、SQL Agent、Binlog Agent 等 |
-| DataProxy | 将接收到的数据转发到不同的消息队列 |
支持数据发送阻塞和落盘重发 |
-| Sort | 数据流分拣 |
主要有基于Flink的sort-flink，sort-standalone 本地分拣 |
-| TubeMQ | InLong自带的消息队列服务 |
也可以叫Tube，拥有低成本、高性能特性 |
-| Pulsar | 即[Apache Pulsar](https://pulsar.apache.org/), 高性能、高一致性消息队列服务 |
-| Hive | 即[Apache Hive](https://hive.apache.org/)，一个建立在Hadoop架构之上的数据仓库 |
-| ClickHouse | [ClickHouse](https://clickhouse.com/)，高性能列式OLAP 数据库 | |
\ No newline at end of file
+| Name | Description |
Other |
+|------------|---------------------------------------------------------------|--------------------------------------------|
+| Group | 数据流组，包含多个数据流，一个Group 代表一个数据接入 |
Group 有ID、Name 等属性 |
+| Stream | 数据流，一个数据流有具体的流向 |
Stream 有ID、Name、数据字段等属性 |
+| Node | 数据节点，包括`Extract Node` 和 `Load Node`，分别代表数据源类型和数据流向目标类型 |
|
+| InLongMsg | InLong 数据格式，如果从消息队列中直接消费，需要先进行`InLongMsg` 解析 |
|
+| Agent | 代表各种采集能力 |
包含文件Agent、SQL Agent、Binlog Agent 等 |
+| DataProxy | 将接收到的数据转发到不同的消息队列 |
支持数据发送阻塞和落盘重发 |
+| Sort | 数据流分拣 |
主要有基于Flink的sort-flink，sort-standalone 本地分拣 |
+| TubeMQ | InLong自带的消息队列服务 |
也可以叫Tube，拥有低成本、高性能特性 |
+| Pulsar | 即[Apache Pulsar](https://pulsar.apache.org/), 高性能、高一致性消息队列服务 |
|
+| Hive | 即[Apache Hive](https://hive.apache.org/)，一个建立在Hadoop架构之上的数据仓库 |
|
+| ClickHouse | [ClickHouse](https://clickhouse.com/)，高性能列式OLAP 数据库 |
|
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/design_and_concept/extend_sink_in_sort.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/design_and_concept/how_to_write_plugin_sort.md
similarity index 100%
rename from
i18n/zh-CN/docusaurus-plugin-content-docs/current/design_and_concept/extend_sink_in_sort.md
rename to
i18n/zh-CN/docusaurus-plugin-content-docs/current/design_and_concept/how_to_write_plugin_sort.md
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/command_line_tools.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/command_line_tools.md
index 8aef5cdcf..a760fc607 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/command_line_tools.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/command_line_tools.md
@@ -3,19 +3,8 @@ title: 命令行工具
sidebar_position: 2
---
-## 配置
-
-前往 `inlong-manager` 目录，修改 `conf/application.properties` 文件的以下配置即可。
-
-```
-server.host=127.0.0.1
-server.port=8080
-default.admin.user=admin
-default.admin.password=inlong
-```
-
## 总览
-
+除了 [InLong Dashboard](user_guide/dashboard_usage.md)，你可以通过命令行工具来查看和创建数据 Group
和 Stream。
```
Usage: managerctl [options] [command] [command options]
Options:
@@ -34,6 +23,17 @@ Usage: managerctl [options] [command] [command options]
目前命令行工具支持 `list`、`describe` 以及 `create` 三个命令。
+## 配置
+
+前往 `inlong-manager` 目录，修改 `conf/application.properties` 文件的以下配置即可。
+
+```
+server.host=127.0.0.1
+server.port=8080
+default.admin.user=admin
+default.admin.password=inlong
+```
+
## List
```
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/dashboard_usage.md
similarity index 98%
rename from
i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/user_manual.md
rename to
i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/dashboard_usage.md
index 1ac16791d..25f509c63 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/dashboard_usage.md
@@ -1,5 +1,5 @@
---
-title: 使用手册
+title: Dashboard 使用指引
sidebar_position: 1
---
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
index a6090dde6..6589065ab 100644
Binary files
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/user-login.png
and
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user_guide/img/user-login.png
differ
