Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[INLONG-1076][Doc] Improve the display of documents for next and 2.0.0 #1077

Merged
merged 2 commits into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/data_node/extract_node/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The following table shows the version mapping between InLong<sup>®</sup> Extrac
| <font color="DarkCyan">1.2.0</font> | <font color="MediumVioletRed">1.15.4</font> |

## Usage for SQL API
- [Deploy InLong Sort](modules/sort/quick_start.md)
- [Deploy InLong Sort](modules/sort/deployment.md)
- Create Data Node

The example shows how to create a MySQL Extract Node in [Flink SQL Client](https://ci.apache.org/projects/flink/flink-docs-release-1.13/dev/table/sqlClient.html) and execute queries on it.
Expand Down
2 changes: 1 addition & 1 deletion docs/data_node/load_node/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The following table shows the version mapping between InLong<sup>®</sup> Load N
| <font color="DarkCyan">1.2.0</font> | <font color="MediumVioletRed">1.15.4</font> |

## Usage for SQL API
- [Deploy InLong Sort](modules/sort/quick_start.md)
- [Deploy InLong Sort](modules/sort/deployment.md)
- Create Data Node

The example shows how to create a MySQL Load Node in [Flink SQL Client](https://ci.apache.org/projects/flink/flink-docs-release-1.13/dev/table/sqlClient.html) and load data to it.
Expand Down
12 changes: 6 additions & 6 deletions docs/deployment/bare_metal.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ You need deploy all InLong components for Standard Architecture, which supports
### Deploy
| order | component | dependencies | deploy guide | description |
|-------|------------------------|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
| 1 | inlong-audit | MySQL or StarRocks | [InLong Audit](modules/audit/quick_start.md) | |
| 2 | inlong-manager | MySQL | [InLong Manager](modules/manager/quick_start.md) | |
| 3 | inlong-dataproxy | None | [InLong DataProxy](modules/dataproxy/quick_start.md) | |
| 4 | inlong-agent | None | [InLong Agent](modules/agent/quick_start.md) | |
| 5 | inlong-dashboard | Nginx or Docker | [InLong Dashboard](modules/dashboard/quick_start.md) | |
| 1 | inlong-audit | MySQL or StarRocks | [InLong Audit](modules/audit/deployment.md) | |
| 2 | inlong-manager | MySQL | [InLong Manager](modules/manager/deployment.md) | |
| 3 | inlong-dataproxy | None | [InLong DataProxy](modules/dataproxy/deployment.md) | |
| 4 | inlong-agent | None | [InLong Agent](modules/agent/deployment.md) | |
| 5 | inlong-dashboard | Nginx or Docker | [InLong Dashboard](modules/dashboard/deployment.md) | |
| 6 | inlong-sort-connectors | Apache Flink 1.13.x or 1.15.x | Extract [apache-inlong-[version]-sort-connectors.tar.gz](https://inlong.apache.org/download/) and move connectors jar to `inlong-sort/connectors` directory. | |

### Create Data Stream
Expand All @@ -35,4 +35,4 @@ After the InLong cluster deployed successfully, you can create a data stream ref
## Lightweight Architecture
### Deploy
Lightweight Architecture only support `Data Synchronization`, you need to deploy InLong Sort component, it is simple and flexible, suitable for small-scale data.
You can deploy and use it refer [the deployment guide](modules/sort/quick_start.md).
You can deploy and use it refer [the deployment guide](modules/sort/deployment.md).
2 changes: 1 addition & 1 deletion docs/development/extension_agent/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Agent Plugins Extension",
"position": 4
"position": 3
}
2 changes: 1 addition & 1 deletion docs/development/extention_dataproxy/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "DataProxy Plugins Extension",
"position": 2
"position": 4
}
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/modules/agent/metrics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Monitor Metrics
sidebar_position: 3
sidebar_position: 4
---

## JMX Configuration
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Deployment
sidebar_position: 2
---

All installation files are in the `inlong-audit` directory, if you use MySQL to store audit data, you need to first create the database through `sql/apache_inlong_audit_mysql.sql`.
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/modules/sort-standalone/pulsar2kafka.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Pulsar2kafka Example
sidebar_position: 6
sidebar_position: 5
---

## Prepare to get module archive
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/modules/sort/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The following will introduce SQL, Dashboard, Manager Client Tools methods to use
- Apache Hive 3.x

## Prepare InLong Sort And Connectors
You can prepare InLong Sort and Data Node Connectors by referring to [Deployment Guide](quick_start.md).
You can prepare InLong Sort and Data Node Connectors by referring to [Deployment Guide](deployment).

## Usage for SQL API

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: client partition assign
sidebar_position: 7
---

## 1 Preface
Expand Down
1 change: 1 addition & 0 deletions docs/modules/tubemq/clients_java.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TubeMQ JAVA SDK API
sidebar_position: 8
---


Expand Down
2 changes: 1 addition & 1 deletion docs/modules/tubemq/commandline_tools.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Command-line Tools
sidebar_position: 15
sidebar_position: 6
---

## Overview
Expand Down
1 change: 1 addition & 0 deletions docs/modules/tubemq/configure_introduction.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Configuration
sidebar_position: 9
---

## TubeMQ configuration item description
Expand Down
1 change: 1 addition & 0 deletions docs/modules/tubemq/console_introduction.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Console Introduction
sidebar_position: 10
---

## 1 Control console relationship
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/tubemq/consumer_example.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Consumer Example
sidebar_position: 5
sidebar_position: 4
---

## 1 Consumer Example
Expand Down
1 change: 1 addition & 0 deletions docs/modules/tubemq/error_code.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Error Code
sidebar_position: 11
---

## 1 Introduction of TubeMQ Error
Expand Down
1 change: 1 addition & 0 deletions docs/modules/tubemq/http_access_api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: HTTP API
sidebar_position: 12
---

## 1 Master metadata configuration API
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/tubemq/producer_example.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Producer Example
sidebar_position: 4
sidebar_position: 3
---

## 1 Producer Example
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/tubemq/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ From the log, we can see the message received by the consumer.
![Demo 2](img/tubemq-consume-message.png)

## Deploy Manager
You can refer to [InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
You can refer to [InLong TubeMQ Manager](modules/tubemq/tubemq-manager/deployment.md)

## The End
Here, the compilation, deployment, system configuration, startup, production and consumption of TubeMQ have been completed. If you need to understand more in-depth content, please check the relevant content in "TubeMQ HTTP API" and make the corresponding configuration settings.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Deployment
sidebar_position: 2
---

All deploying files at `inlong-tubemq-manager` directory.
Expand Down
1 change: 1 addition & 0 deletions docs/modules/tubemq/tubemq-manager/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Overview
sidebar_position: 1
---

Operation interface
Expand Down
1 change: 1 addition & 0 deletions docs/modules/tubemq/tubemq_metrics.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TubeMQ Metrics
sidebar_position: 13
---

## 1 Introduction to TubeMQ metric set
Expand Down
1 change: 1 addition & 0 deletions docs/modules/tubemq/tubemq_perf_test_vs_Kafka.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TubeMQ VS Kafka
sidebar_position: 14
---

## 1 Background
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Extract 节点列表是一组基于 <a href="https://flink.apache.org/">Apache F
| <font color="DarkCyan">1.2.0</font> | <font color="MediumVioletRed">1.13.5</font> |

## SQL API 用法
- [部署 InLong Sort](modules/sort/quick_start.md)
- [部署 InLong Sort](modules/sort/deployment.md)
- 创建数据节点

下面例子展示了如何在 [Flink SQL Client](https://ci.apache.org/projects/flink/flink-docs-release-1.13/dev/table/sqlClient.html) 创建 MySQL Extract 节点,并从中查询数据:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Load 节点列表是一组基于 <a href="https://flink.apache.org/">Apache Flin
| <font color="DarkCyan">1.2.0</font> | <font color="MediumVioletRed">1.13.5</font> |

## SQL API 的用法
- [部署 InLong Sort](modules/sort/quick_start.md)
- [部署 InLong Sort](modules/sort/deployment.md)
- 创建数据节点

下面例子展示了如何在 [Flink SQL Client](https://ci.apache.org/projects/flink/flink-docs-release-1.13/dev/table/sqlClient.html) 创建一个 MySQL Load 节点并加载数据进去:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,18 @@ InLong 当前支持以下消息队列,根据使用情况**选择其一**即可
标准架构下,你需要部署所有 InLong 组件,同时支持`数据接入`、`数据同步`和`数据订阅`。

### 安装
| 顺序 | 组件 | 第三方依赖 | 部署指引 | 说明 |
|--------|---------------------------|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|-----|
| 1 | inlong-audit | MySQL 或者 StarRocks | [InLong Audit](modules/audit/quick_start.md) | |
| 2 | inlong-manager | MySQL | [InLong Manager](modules/manager/quick_start.md) | |
| 3 | inlong-dataproxy | 无 | [InLong DataProxy](modules/dataproxy/quick_start.md) | |
| 4 | inlong-agent | 无 | [InLong Agent](modules/agent/quick_start.md) | |
| 5 | inlong-dashboard | Nginx 或者 Docker | [InLong Dashboard](modules/dashboard/quick_start.md) | |
| 顺序 | 组件 | 第三方依赖 | 部署指引 | 说明 |
|--------|---------------------------|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| 1 | inlong-audit | MySQL 或者 StarRocks | [InLong Audit](modules/audit/deployment.md) | |
| 2 | inlong-manager | MySQL | [InLong Manager](modules/manager/deployment.md) | |
| 3 | inlong-dataproxy | 无 | [InLong DataProxy](modules/dataproxy/deployment.md) | |
| 4 | inlong-agent | 无 | [InLong Agent](modules/agent/deployment.md) | |
| 5 | inlong-dashboard | Nginx 或者 Docker | [InLong Dashboard](modules/dashboard/deployment.md) | |
| 6 | inlong-sort-connectors | Apache Flink 1.13.x 或者 1.15.x | 解压 [apache-inlong-[version]-sort-connectors.tar.gz](https://inlong.apache.org/zh-CN/download/) 然后将 connectors jar 放到 `inlong-sort/connectors` 目录。 | |

### 创建数据流
InLong 集群部署成功后,你可以参考[Dashboard 使用指引](user_guide/dashboard_usage.md)创建一个数据流开始使用。

## 轻量化架构
### 安装
轻量化架构只支持`数据同步`,需要部署 InLong Sort 组件, 拥有简单、灵活,适合小规模数据的特点。你可以参考[部署指引](modules/sort/quick_start.md)进行安装和使用
轻量化架构只支持`数据同步`,需要部署 InLong Sort 组件, 拥有简单、灵活,适合小规模数据的特点。你可以参考[部署指引](modules/sort/deployment.md)进行安装和使用
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: REST API
sidebar_position: 8
sidebar_position: 9
---

<!-- 为了保持显示一致,请删除原始 `api.json` 中的 `info` 和 `host` 内容 -->
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 监控指标
sidebar_position: 3
sidebar_position: 4
---

## JMX 配置
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: 安装部署
sidebar_position: 2
---

所有的安装文件都在 `inlong-audit` 目录下,如果使用 MySQL 存储审计数据,需要先通过 `sql/apache_inlong_audit_mysql.sql` 初始化数据库。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sidebar_position: 3
- Apache Hive 3.x

## 准备 InLong Sort 和 Connectors
你可以通过参考[部署指引](quick_start.md)准备 InLong Sort 和数据节点 Connectors。
你可以通过参考[部署指引](deployment)准备 InLong Sort 和数据节点 Connectors。

## 使用 SQL API 方式

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: 客户端分区分配
sidebar_position: 7
---

## 1 前言
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: JAVA SDK API
sidebar_position: 8
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 命令行工具
sidebar_position: 15
sidebar_position: 6
---

## 总览
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: 配置参数
sidebar_position: 9
---

## TubeMQ 服务端配置文件说明:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TubeMQ管控台操作指引
sidebar_position: 10
---

## 1 管控台关系
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 消费者示例
sidebar_position: 5
sidebar_position: 4
---

## 1 Consumer 示例
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: 错误码定义
sidebar_position: 11
---

## 1 TubeMQ错误信息介绍
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: HTTP API 介绍
sidebar_position: 12
---

HTTP API 是 Master 或者 Broker 对外功能暴露的接口,管控台的各项操作都是基于这些 API 进行;如果有最新的功能,或者管控台没有涵盖的功能,业务都可以直接通过调用 HTTP API 接口完成。
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 生产者示例
sidebar_position: 4
sidebar_position: 3
---

## 1 Producer 示例
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 快速开始
sidebar_position: 1
sidebar_position: 2
---
## 部署运行

Expand Down Expand Up @@ -177,7 +177,7 @@ cd /INSTALL_PATH/apache-inlong-tubemq-server-[TUBEMQ-VERSION]-bin
![Demo 2](img/tubemq-consume-message.png)

## 部署 Manager
参考 [InLong TubeMQ Manager](modules/tubemq/tubemq-manager/quick_start.md)
参考 [InLong TubeMQ Manager](modules/tubemq/tubemq-manager/deployment.md)

---
<a href="#top">Back to top</a>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: 安装部署
sidebar_position: 2
---

安装文件在inlong-tubemq-manager目录.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: 总览
sidebar_position: 1
---

操作接口
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TubeMQ指标
sidebar_position: 13
---

## 1 TubeMQ指标集介绍
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: TubeMQ VS Kafka
sidebar_position: 14
---

## 1 背景
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Extract 节点列表是一组基于 <a href="https://flink.apache.org/">Apache F
| <font color="DarkCyan">1.2.0</font> | <font color="MediumVioletRed">1.13.5</font> |

## SQL API 用法
- [部署 InLong Sort](modules/sort/quick_start.md)
- [部署 InLong Sort](modules/sort/deployment.md)
- 创建数据节点

下面例子展示了如何在 [Flink SQL Client](https://ci.apache.org/projects/flink/flink-docs-release-1.13/dev/table/sqlClient.html) 创建 MySQL Extract 节点,并从中查询数据:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Load 节点列表是一组基于 <a href="https://flink.apache.org/">Apache Flin
| <font color="DarkCyan">1.2.0</font> | <font color="MediumVioletRed">1.13.5</font> |

## SQL API 的用法
- [部署 InLong Sort](modules/sort/quick_start.md)
- [部署 InLong Sort](modules/sort/deployment.md)
- 创建数据节点

下面例子展示了如何在 [Flink SQL Client](https://ci.apache.org/projects/flink/flink-docs-release-1.13/dev/table/sqlClient.html) 创建一个 MySQL Load 节点并加载数据进去:
Expand Down
Loading
Loading