You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by ha...@apache.org on 2025/09/29 11:32:46 UTC
(iotdb) branch master updated: update readme links (#16523)
This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new 5e00ed5e815 update readme links (#16523)
5e00ed5e815 is described below
commit 5e00ed5e815a6ffbca412c5ed78ecec9284e4730
Author: CritasWang <cr...@outlook.com>
AuthorDate: Mon Sep 29 19:32:41 2025 +0800
update readme links (#16523)
---
CONTRIBUTING.md | 2 +-
README.md | 18 ++++++++++--------
README_ZH.md | 17 +++++++++--------
docker/ReadMe.md | 2 +-
iotdb-client/client-cpp/README.md | 2 +-
iotdb-core/metrics/ReadMe.md | 4 ++--
6 files changed, 24 insertions(+), 21 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e29a9cd2540..a80f5284aad 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -27,7 +27,7 @@ IoTDB official website:https://iotdb.apache.org/
Code library:https://github.com/apache/iotdb/tree/master
-Get started quickly:https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html
+Get started quickly:https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart.html
## Subscribe to mailing list
diff --git a/README.md b/README.md
index 20aed0827a3..09ae373aba9 100644
--- a/README.md
+++ b/README.md
@@ -83,7 +83,7 @@ For the latest information about IoTDB, please visit [IoTDB official website](ht
# Quick Start
-This short guide will walk you through the basic process of using IoTDB. For a more detailed introduction, please visit our website's [User Guide](https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html).
+This short guide will walk you through the basic process of using IoTDB. For a more detailed introduction, please visit our website's [User Guide](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart.html).
## Prerequisites
@@ -220,7 +220,7 @@ IoTDB provides three installation methods, you can refer to the following sugges
* Using Docker:The path to the dockerfile is [here](https://github.com/apache/iotdb/tree/master/docker/src/main).
-Here in the Quick Start, we give a brief introduction of using source code to install IoTDB. For further information, please refer to [User Guide](https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html).
+Here in the Quick Start, we give a brief introduction of using source code to install IoTDB. For further information, please refer to [User Guide](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart.html).
## Build from source
@@ -307,10 +307,10 @@ you run `mvn package` successfully.**
Configuration files are under the "conf" folder.
* environment config module (`datanode-env.bat`, `datanode-env.sh`),
- * system config module (`iotdb-datanode.properties`)
+ * system config module (`iotdb-system.properties`)
* log config module (`logback.xml`).
-For more information, please see [Config Manual](https://iotdb.apache.org/UserGuide/Master/Reference/DataNode-Config-Manual.html).
+For more information, please see [Config Manual](https://iotdb.apache.org/UserGuide/latest/Reference/DataNode-Config-Manual.html).
## Start
@@ -482,7 +482,7 @@ or
IoTDB> exit
```
-For more information about the commands supported by IoTDB SQL, please see [User Guide](https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html).
+For more information about the commands supported by IoTDB SQL, please see [User Guide](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart.html).
### Stop IoTDB
@@ -496,12 +496,14 @@ The server can be stopped with "ctrl-C" or the following script:
> sbin\stop-standalone.bat
```
-# The use of CSV Import and Export Tool
+# The use of Data Import and Export Tool
+
+see [The use of Data Import Tool](https://iotdb.apache.org/UserGuide/latest/Tools-System/Data-Import-Tool.html)
+see [The use of Data Export Tool](https://iotdb.apache.org/UserGuide/latest/Tools-System/Data-Export-Tool.html)
-see [The use of CSV Import and Export Tool](https://iotdb.apache.org/UserGuide/latest/Tools-System/Import-Export-Tool.html)
# Frequent Questions for Compiling
-see [Frequent Questions when Compiling the Source Code](https://iotdb.apache.org/Development/ContributeGuide.html#_Frequent-Questions-when-Compiling-the-Source-Code)
+see [Frequent Questions when Compiling the Source Code](https://iotdb.apache.org/Community/Development-Guide.html#frequently-asked-questions)
# Contact Us
diff --git a/README_ZH.md b/README_ZH.md
index 359e3307379..c30fe7501e3 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -81,7 +81,7 @@ IoTDB的主要特点如下:
# 快速开始
-这篇简短的指南将带您了解使用IoTDB的基本过程。如需更详细的介绍,请访问我们的网站[用户指南](https://iotdb.apache.org/zh/UserGuide/Master/QuickStart/QuickStart.html)。
+这篇简短的指南将带您了解使用IoTDB的基本过程。如需更详细的介绍,请访问我们的网站[用户指南](https://iotdb.apache.org/zh/UserGuide/latest/QuickStart/QuickStart.html)。
## 环境准备
@@ -108,7 +108,7 @@ IoTDB提供了三种安装方法,您可以参考以下建议,选择最适合
* 使用Docker: dockerfile的路径是https://github.com/apache/iotdb/tree/master/docker/src/main
-在这篇《快速入门》中,我们简要介绍如何使用源代码安装IoTDB。如需进一步资料,请参阅官网[用户指南](https://iotdb.apache.org/zh/UserGuide/Master/QuickStart/QuickStart.html)。
+在这篇《快速入门》中,我们简要介绍如何使用源代码安装IoTDB。如需进一步资料,请参阅官网[用户指南](https://iotdb.apache.org/zh/UserGuide/latest/QuickStart/QuickStart.html)。
## 从源码构建
@@ -182,10 +182,10 @@ git checkout rel/x.x
配置文件在"conf"文件夹下
* 环境配置模块(`datanode-env.bat`, `datanode-env.sh`),
-* 系统配置模块(`iotdb-datanode.properties`)
+* 系统配置模块(`iotdb-system.properties`)
* 日志配置模块(`logback.xml`)。
-有关详细信息,请参见[配置参数](https://iotdb.apache.org/zh/UserGuide/Master/Reference/DataNode-Config-Manual.html)。
+有关详细信息,请参见[配置参数](https://iotdb.apache.org/zh/UserGuide/latest/Reference/DataNode-Config-Manual.html)。
## 开始
@@ -364,7 +364,7 @@ or
IoTDB> exit
```
-有关IoTDB SQL支持的命令的更多信息,请参见[用户指南](https://iotdb.apache.org/zh/UserGuide/Master/QuickStart/QuickStart.html)。
+有关IoTDB SQL支持的命令的更多信息,请参见[用户指南](https://iotdb.apache.org/zh/UserGuide/latest/QuickStart/QuickStart.html)。
### 停止 IoTDB
@@ -378,12 +378,13 @@ server 可以使用 "ctrl-C" 或者执行下面的脚本:
> sbin\stop-standalone.bat
```
-# 导入导出CSV工具
+# 数据导入导出工具
-查看 [导入导出CSV工具](https://iotdb.apache.org/zh/UserGuide/latest/Tools-System/Import-Export-Tool.html)
+查看 [数据导入工具](https://iotdb.apache.org/zh/UserGuide/latest/Tools-System/Data-Import-Tool.html)
+查看 [数据导出工具](https://iotdb.apache.org/zh/UserGuide/latest/Tools-System/Data-Export-Tool.html)
# 常见编译错误
-查看 [常见编译错误](https://iotdb.apache.org/zh/Community/Development-Guide.html)
+查看 [常见编译错误](https://iotdb.apache.org/zh/Community/Development-Guide.html#%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98)
# 联系我们
### QQ群
diff --git a/docker/ReadMe.md b/docker/ReadMe.md
index b08f20cc44f..1574099c374 100644
--- a/docker/ReadMe.md
+++ b/docker/ReadMe.md
@@ -81,7 +81,7 @@ docker run -d --name iotdb -p 6667:6667 -p 31999:31999 -p 8181:8181 -p 5555:5555
```shell
docker run -d --name iotdb -p 6667:6667 -p 31999:31999 -p 8181:8181 -p 5555:5555 -p 9003:9003 -p 40010:40010 apache/iotdb:<version>
```
-Since 1.0.0, see [offical documents.](https://iotdb.apache.org/UserGuide/Master/QuickStart/WayToGetIoTDB.html)
+Since 1.0.0, see [offical documents.](https://iotdb.apache.org/UserGuide/latest/QuickStart/QuickStart.html)
# How to register AINode to IoTDB cluster
diff --git a/iotdb-client/client-cpp/README.md b/iotdb-client/client-cpp/README.md
index db372bbae11..15b24e9f520 100644
--- a/iotdb-client/client-cpp/README.md
+++ b/iotdb-client/client-cpp/README.md
@@ -129,7 +129,7 @@ mentioned above, the header file and the dynamic library:
unzip client-cpp-${project.version}-cpp-${os}.zip
3. Write C++ code to call the operation interface of the cpp client to operate IoTDB,
- for detail interface information, please refer to the link: https://iotdb.apache.org/zh/UserGuide/Master/API/Programming-Cpp-Native-API.html
+ for detail interface information, please refer to the link: https://iotdb.apache.org/UserGuide/latest/API/Programming-Cpp-Native-API.html
E.g:
#include "include/Session.h"
diff --git a/iotdb-core/metrics/ReadMe.md b/iotdb-core/metrics/ReadMe.md
index d77ddda8cb1..ef07bd37524 100644
--- a/iotdb-core/metrics/ReadMe.md
+++ b/iotdb-core/metrics/ReadMe.md
@@ -128,5 +128,5 @@ MetricService.getInstance().count(1, "operation_count", MetricLevel.IMPORTANT, "
2. These metrics will be managed by your MetricManager, and reported by your reporter.
# 5. Some docs
-1. <a href = "https://iotdb.apache.org/UserGuide/Master/Maintenance-Tools/Metric-Tool.html">Metric Tool</a>
-2. <a href = "https://iotdb.apache.org/zh/UserGuide/Master/Maintenance-Tools/Metric-Tool.html">Metric Tool(zh)</a>
\ No newline at end of file
+1. <a href = "https://iotdb.apache.org/UserGuide/latest/Tools-System/Monitor-Tool.html">Metric Tool</a>
+2. <a href = "https://iotdb.apache.org/zh/UserGuide/latest/Tools-System/Monitor-Tool.html">Metric Tool(zh)</a>
\ No newline at end of file