From df038b51948ace886ee78fee27e03de2e851c6c5 Mon Sep 17 00:00:00 2001 From: gccgdb1234 Date: Tue, 19 Apr 2022 12:40:48 +0800 Subject: [PATCH] docs: correct links for taosadapter, taosdump, taosbenchmark and tdinsight --- docs-cn/09-third-party/01-grafana.mdx | 2 +- docs-cn/11-operation/07-import.md | 2 +- docs-cn/11-operation/08-export.md | 2 +- docs-cn/11-operation/10-monitor.md | 2 +- docs-cn/14-reference/02-restful-api/02-restful-api.mdx | 2 +- docs-cn/14-reference/12-config/index.md | 8 ++++---- docs-cn/15-application/03-immigrate.md | 2 +- docs-cn/17-train-fqa/01-faq.md | 2 +- docs-cn/17-train-fqa/03-docker.md | 2 +- 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs-cn/09-third-party/01-grafana.mdx b/docs-cn/09-third-party/01-grafana.mdx index 2f3b14308a..7c6badd94d 100644 --- a/docs-cn/09-third-party/01-grafana.mdx +++ b/docs-cn/09-third-party/01-grafana.mdx @@ -92,4 +92,4 @@ GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=tdengine-datasource ### 导入 Dashboard -在 2.3.3.0 及以上版本，您可以导入 TDinsight Dashboard (Grafana Dashboard ID： [15167](https://grafana.com/grafana/dashboards/15167)) 作为 TDengine 集群的监控可视化工具。安装和使用说明请见 [TDinsight 用户手册](https://github.com/taosdata/grafanaplugin/blob/master/dashboards/TDinsight-CN.md)。 +在 2.3.3.0 及以上版本，您可以导入 TDinsight Dashboard (Grafana Dashboard ID： [15167](https://grafana.com/grafana/dashboards/15167)) 作为 TDengine 集群的监控可视化工具。安装和使用说明请见 [TDinsight 用户手册](/reference/tdinsight/)。 diff --git a/docs-cn/11-operation/07-import.md b/docs-cn/11-operation/07-import.md index 9bf8c87025..7dee05720d 100644 --- a/docs-cn/11-operation/07-import.md +++ b/docs-cn/11-operation/07-import.md @@ -58,4 +58,4 @@ Query OK, 9 row(s) affected (0.004763s) ## taosdump 工具导入 -TDengine 提供了方便的数据库导入导出工具 taosdump。用户可以将 taosdump 从一个系统导出的数据，导入到其他系统中。具体使用方法，请参见：[TDengine 数据备份工具: taosdump](https://github.com/taosdata/taos-tools/blob/develop/taosdump-user-manual-CN.md)。 +TDengine 提供了方便的数据库导入导出工具 taosdump。用户可以将 taosdump 从一个系统导出的数据，导入到其他系统中。具体使用方法，请参见：[TDengine 数据备份工具: taosdump](/reference/taosdump)。 diff --git a/docs-cn/11-operation/08-export.md b/docs-cn/11-operation/08-export.md index b3b4d8edcc..042ecc7ba2 100644 --- a/docs-cn/11-operation/08-export.md +++ b/docs-cn/11-operation/08-export.md @@ -17,4 +17,4 @@ select * from >> data.csv; ## 用 taosdump 导出数据 利用 taosdump，用户可以根据需要选择导出所有数据库、一个数据库或者数据库中的一张表，所有数据或一时间段的数据，甚至仅仅表的定义。具体使用方法，请参见： -[TDengine 数据备份工具: taosdump](https://github.com/taosdata/taos-tools/blob/develop/taosdump-user-manual-CN.md)。 +[TDengine 数据备份工具: taosdump](/reference/taosdump)。 diff --git a/docs-cn/11-operation/10-monitor.md b/docs-cn/11-operation/10-monitor.md index d866748613..e30be775fb 100644 --- a/docs-cn/11-operation/10-monitor.md +++ b/docs-cn/11-operation/10-monitor.md @@ -51,4 +51,4 @@ chmod +x TDinsight.sh 运行程序并重启 Grafana 服务，打开面板：`http://localhost:3000/d/tdinsight`。 -更多使用场景和限制请参考[TDinsight](https://github.com/taosdata/grafanaplugin/blob/master/dashboards/TDinsight.md) 文档。 +更多使用场景和限制请参考[TDinsight](/reference/tdinsight/) 文档。 diff --git a/docs-cn/14-reference/02-restful-api/02-restful-api.mdx b/docs-cn/14-reference/02-restful-api/02-restful-api.mdx index 17df002b08..7df29edaf6 100644 --- a/docs-cn/14-reference/02-restful-api/02-restful-api.mdx +++ b/docs-cn/14-reference/02-restful-api/02-restful-api.mdx @@ -302,6 +302,6 @@ HTTP 请求 URL 采用 `sqlutc` 时，返回结果集的时间戳将采用 UTC - httpDbNameMandatory: 是否必须在 RESTful url 中指定默认的数据库名。默认为 0，即关闭此检查。如果设置为 1，那么每个 RESTful url 中都必须设置一个默认数据库名，否则无论此时执行的 SQL 语句是否需要指定数据库，都会返回一个执行错误，拒绝执行此 SQL 语句。 :::note -如果使用 taosd 提供的 RESTful API, 那么以上配置需要写在 taosd 的配置文件 taos.cfg 中。如果使用 taosAdaper 提供的 RESTful API, 那么需要参考 taosAdaper [对应的配置方法](https://github.com/taosdata/taosadapter/blob/develop/README-CN.md#%E5%A6%82%E4%BD%95%E4%BB%8E%E6%97%A7%E7%89%88%E6%9C%AC-tdengine-%E8%BF%81%E7%A7%BB%E5%88%B0-taosadapter)。 +如果使用 taosd 提供的 RESTful API, 那么以上配置需要写在 taosd 的配置文件 taos.cfg 中。如果使用 taosAdaper 提供的 RESTful API, 那么需要参考 taosAdaper [对应的配置方法](/reference/taosadapter/)。 ::: diff --git a/docs-cn/14-reference/12-config/index.md b/docs-cn/14-reference/12-config/index.md index 4a4b1aba04..d008aa4799 100644 --- a/docs-cn/14-reference/12-config/index.md +++ b/docs-cn/14-reference/12-config/index.md @@ -88,7 +88,7 @@ taos --dump-config | TCP | 6030 | 客户端与服务端之间通讯。 | 由配置文件设置 serverPort 决定。 | | TCP | 6035 | 多节点集群的节点间通讯。 | 随 serverPort 端口变化。 | | TCP | 6040 | 多节点集群的节点间数据同步。 | 随 serverPort 端口变化。 | -| TCP | 6041 | 客户端与服务端之间的 RESTful 通讯。 | 随 serverPort 端口变化。注意 taosAdapter 配置或有不同，请参考相应[文档](https://github.com/taosdata/taosadapter/blob/develop/README-CN.md)。 | +| TCP | 6041 | 客户端与服务端之间的 RESTful 通讯。 | 随 serverPort 端口变化。注意 taosAdapter 配置或有不同，请参考相应[文档](/reference/taosadapter/)。 | | TCP | 6042 | Arbitrator 的服务端口。 | 随 Arbitrator 启动参数设置变化。 | | TCP | 6043 | TaosKeeper 监控服务端口。 | 随 TaosKeeper 启动参数设置变化。 | | TCP | 6044 | 支持 StatsD 的数据接入端口。 | 随 taosAdapter 启动参数设置变化（2.3.0.1+以上版本）。 | @@ -784,7 +784,7 @@ taos --dump-config :::note HTTP服务在2.4.0.0（不含）以前的版本中由taosd提供，在2.4.0.0以后（含）由taosAdapter提供。 -本节的配置参数仅在2.4.0.0（不含）以前的版本中生效。如果您使用的是2.4.0.0（含）及以后的版本请参考[文档](https://github.com/taosdata/taosadapter/blob/develop/README-CN.md)。 +本节的配置参数仅在2.4.0.0（不含）以前的版本中生效。如果您使用的是2.4.0.0（含）及以后的版本请参考[文档](/reference/taosadapter/)。 ::: @@ -811,7 +811,7 @@ HTTP服务在2.4.0.0（不含）以前的版本中由taosd提供，在2.4.0.0以 | 属性 | 说明 | | -------- | --------------------------------------------------------------------------------------------------------------------------- | | 适用范围 | 仅服务端适用 | -| 含义 | RESTFul 接口的线程数。taosAdapter 配置或有不同，请参考相应[文档](https://github.com/taosdata/taosadapter/blob/develop/README-CN.md)。 | +| 含义 | RESTFul 接口的线程数。taosAdapter 配置或有不同，请参考相应[文档](/reference/taosadapter/)。 | | 缺省值 | 2 | ### restfulRowLimit @@ -819,7 +819,7 @@ HTTP服务在2.4.0.0（不含）以前的版本中由taosd提供，在2.4.0.0以 | 属性 | 说明 | | -------- | ------------------------------------------------------------------------------------------------------------------------------------- | | 适用范围 | 仅服务端适用 | -| 含义 | RESTFul 接口单次返回的记录条数。taosAdapter 配置或有不同，请参考相应[文档](https://github.com/taosdata/taosadapter/blob/develop/README-CN.md)。 | +| 含义 | RESTFul 接口单次返回的记录条数。taosAdapter 配置或有不同，请参考相应[文档](/reference/taosadapter/)。 | | 缺省值 | 10240 | | 补充说明 | 最大 10,000,000 | diff --git a/docs-cn/15-application/03-immigrate.md b/docs-cn/15-application/03-immigrate.md index dee4f78e5b..9b2c04e96e 100644 --- a/docs-cn/15-application/03-immigrate.md +++ b/docs-cn/15-application/03-immigrate.md @@ -47,7 +47,7 @@ title: OpenTSDB 应用迁移到 TDengine 的最佳实践 用户可以根据需求弹性部署 taosAdapter 实例，结合场景的需要，快速提升数据写入的吞吐量，为不同应用场景下的数据写入提供保障。 -通过 taosAdapter，用户可以将 collectd 和 StatsD 收集的数据直接推送到 TDengine ，实现应用场景的无缝迁移，非常的轻松便捷。taosAdapter 还支持 Telegraf、Icinga、TCollector 、node_exporter 的数据接入，使用详情参考[taosAdapter](https://github.com/taosdata/taosadapter/blob/develop/README-CN.md)。 +通过 taosAdapter，用户可以将 collectd 和 StatsD 收集的数据直接推送到 TDengine ，实现应用场景的无缝迁移，非常的轻松便捷。taosAdapter 还支持 Telegraf、Icinga、TCollector 、node_exporter 的数据接入，使用详情参考[taosAdapter](/reference/taosadapter/)。 如果使用 collectd，修改其默认位置 `/etc/collectd/collectd.conf` 的配置文件为指向 taosAdapter 部署的节点 IP 地址和端口。假设 taosAdapter 的 IP 地址为 192.168.1.130，端口为 6046，配置如下： diff --git a/docs-cn/17-train-fqa/01-faq.md b/docs-cn/17-train-fqa/01-faq.md index 66ff53e491..e14564e04e 100644 --- a/docs-cn/17-train-fqa/01-faq.md +++ b/docs-cn/17-train-fqa/01-faq.md @@ -199,7 +199,7 @@ TDengine 中时间戳的时区总是由客户端进行处理，而与服务端 | TCP | 6030 | 客户端与服务端之间通讯。 | 由配置文件设置 serverPort 决定。 | | TCP | 6035 | 多节点集群的节点间通讯。 | 随 serverPort 端口变化。 | | TCP | 6040 | 多节点集群的节点间数据同步。 | 随 serverPort 端口变化。 | -| TCP | 6041 | 客户端与服务端之间的 RESTful 通讯。 | 随 serverPort 端口变化。注意 taosAdapter 配置或有不同，请参考相应[文档](https://github.com/taosdata/taosadapter/blob/develop/README-CN.md)。 | +| TCP | 6041 | 客户端与服务端之间的 RESTful 通讯。 | 随 serverPort 端口变化。注意 taosAdapter 配置或有不同，请参考相应[文档](/reference/taosadapter/)。 | | TCP | 6042 | Arbitrator 的服务端口。 | 随 Arbitrator 启动参数设置变化。 | | TCP | 6043 | TaosKeeper 监控服务端口。 | 随 TaosKeeper 启动参数设置变化。 | | TCP | 6044 | 支持 StatsD 的数据接入端口。 | 随 taosAdapter 启动参数设置变化（2.3.0.1+以上版本）。 | diff --git a/docs-cn/17-train-fqa/03-docker.md b/docs-cn/17-train-fqa/03-docker.md index 5e9d65d49d..d6c3e81cc0 100644 --- a/docs-cn/17-train-fqa/03-docker.md +++ b/docs-cn/17-train-fqa/03-docker.md @@ -125,7 +125,7 @@ TDengine RESTful 接口详情请参考[官方文档](/reference/restful-api/)。 在 TDegnine 2.4.0.0 之后版本的 Docker 容器，开始提供一个独立运行的组件 taosAdapter，代替之前版本 TDengine 中 taosd 进程中内置的 http server。taosAdapter 支持通过 RESTful 接口对 TDengine server 的数据写入和查询能力，并提供和 InfluxDB/OpenTSDB 兼容的数据摄取接口，允许 InfluxDB/OpenTSDB 应用程序无缝移植到 TDengine。在新版本 Docker 镜像中，默认启用了 taosAdapter，也可以使用 docker run 命令中设置 TAOS_DISABLE_ADAPTER=true 来禁用 taosAdapter；也可以在 docker run 命令中单独使用 taosAdapter，而不运行 taosd 。 -注意：如果容器中运行 taosAdapter，需要根据需要映射其他端口，具体端口默认配置和修改方法请参考[taosAdapter 文档](https://github.com/taosdata/taosadapter/blob/develop/README-CN.md)。 +注意：如果容器中运行 taosAdapter，需要根据需要映射其他端口，具体端口默认配置和修改方法请参考[taosAdapter 文档](/reference/taosadapter/)。 使用 docker 运行 TDengine 2.4.0.4 版本镜像（taosd + taosAdapter）： -- GitLab