From d3db93b91394ac4b6d6add3c98fdbb3bd77feb8a Mon Sep 17 00:00:00 2001 From: gccgdb1234 Date: Mon, 12 Aug 2024 15:42:16 +0800 Subject: [PATCH] doc: change based on Jeff comments --- docs/zh/04-get-started/index.md | 2 +- docs/zh/06-advanced/05-data-in/index.md | 11 +++++++++-- .../01-components/03-taosadapter.md | 10 +++++----- .../{ => 01-components}/_collectd.mdx | 0 .../{ => 01-components}/_icinga2.mdx | 0 .../{ => 01-components}/_prometheus.mdx | 0 .../{ => 01-components}/_statsd.mdx | 0 .../{ => 01-components}/_tcollector.mdx | 0 .../{ => 01-components}/_telegraf.mdx | 0 .../01-collection/02-prometheus.md | 2 +- .../20-third-party/01-collection/03-telegraf.md | 2 +- .../20-third-party/01-collection/05-collectd.md | 2 +- .../20-third-party/01-collection/06-statsd.md | 2 +- .../20-third-party/01-collection/07-icinga2.md | 2 +- .../01-collection/08-tcollector.md | 2 +- docs/zh/20-third-party/01-collection/index.md | 17 ++++++++++++----- docs/zh/20-third-party/03-visual/index.md | 17 ++++++++++++----- docs/zh/20-third-party/05-bi/index.md | 17 ++++++++++++----- docs/zh/20-third-party/07-tool/index.md | 17 ++++++++++++----- 19 files changed, 69 insertions(+), 34 deletions(-) rename docs/zh/14-reference/{ => 01-components}/_collectd.mdx (100%) rename docs/zh/14-reference/{ => 01-components}/_icinga2.mdx (100%) rename docs/zh/14-reference/{ => 01-components}/_prometheus.mdx (100%) rename docs/zh/14-reference/{ => 01-components}/_statsd.mdx (100%) rename docs/zh/14-reference/{ => 01-components}/_tcollector.mdx (100%) rename docs/zh/14-reference/{ => 01-components}/_telegraf.mdx (100%) diff --git a/docs/zh/04-get-started/index.md b/docs/zh/04-get-started/index.md index 57bcf9ace3..4422efbf60 100644 --- a/docs/zh/04-get-started/index.md +++ b/docs/zh/04-get-started/index.md @@ -34,4 +34,4 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; 关注 TDengine 视频号
收看技术直播与教学视频 关注 TDengine 公众号
阅读技术文章与行业案例 - + \ No newline at end of file diff --git a/docs/zh/06-advanced/05-data-in/index.md b/docs/zh/06-advanced/05-data-in/index.md index 32d530acb5..1a142fd47a 100644 --- a/docs/zh/06-advanced/05-data-in/index.md +++ b/docs/zh/06-advanced/05-data-in/index.md @@ -1,5 +1,5 @@ --- -sidebar_label: 数据接入 +sidebar_label: 零代码数据写入 title: 零代码第三方数据接入 toc_max_heading_level: 4 --- @@ -273,4 +273,11 @@ let v3 = data["voltage"].split(","); ## 任务管理 -在任务列表页面，还可以对任务进行启动、停止、查看、删除、复制等操作，也可以查看各个任务的运行情况，包括写入的记录条数、流量等。 \ No newline at end of file +在任务列表页面，还可以对任务进行启动、停止、查看、删除、复制等操作，也可以查看各个任务的运行情况，包括写入的记录条数、流量等。 + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/zh/14-reference/01-components/03-taosadapter.md b/docs/zh/14-reference/01-components/03-taosadapter.md index 84facad093..97f2ab4074 100644 --- a/docs/zh/14-reference/01-components/03-taosadapter.md +++ b/docs/zh/14-reference/01-components/03-taosadapter.md @@ -4,11 +4,11 @@ sidebar_label: "taosAdapter" toc_max_heading_level: 4 --- -import Prometheus from "../_prometheus.mdx" -import CollectD from "../_collectd.mdx" -import StatsD from "../_statsd.mdx" -import Icinga2 from "../_icinga2.mdx" -import TCollector from "../_tcollector.mdx" +import Prometheus from "./_prometheus.mdx" +import CollectD from "./_collectd.mdx" +import StatsD from "./_statsd.mdx" +import Icinga2 from "./_icinga2.mdx" +import TCollector from "./_tcollector.mdx" taosAdapter 是一个 TDengine 的配套工具，是 TDengine 集群和应用程序之间的桥梁和适配器。它提供了一种易于使用和高效的方式来直接从数据收集代理软件（如 Telegraf、StatsD、collectd 等）摄取数据。它还提供了 InfluxDB/OpenTSDB 兼容的数据摄取接口，允许 InfluxDB/OpenTSDB 应用程序无缝移植到 TDengine。 diff --git a/docs/zh/14-reference/_collectd.mdx b/docs/zh/14-reference/01-components/_collectd.mdx similarity index 100% rename from docs/zh/14-reference/_collectd.mdx rename to docs/zh/14-reference/01-components/_collectd.mdx diff --git a/docs/zh/14-reference/_icinga2.mdx b/docs/zh/14-reference/01-components/_icinga2.mdx similarity index 100% rename from docs/zh/14-reference/_icinga2.mdx rename to docs/zh/14-reference/01-components/_icinga2.mdx diff --git a/docs/zh/14-reference/_prometheus.mdx b/docs/zh/14-reference/01-components/_prometheus.mdx similarity index 100% rename from docs/zh/14-reference/_prometheus.mdx rename to docs/zh/14-reference/01-components/_prometheus.mdx diff --git a/docs/zh/14-reference/_statsd.mdx b/docs/zh/14-reference/01-components/_statsd.mdx similarity index 100% rename from docs/zh/14-reference/_statsd.mdx rename to docs/zh/14-reference/01-components/_statsd.mdx diff --git a/docs/zh/14-reference/_tcollector.mdx b/docs/zh/14-reference/01-components/_tcollector.mdx similarity index 100% rename from docs/zh/14-reference/_tcollector.mdx rename to docs/zh/14-reference/01-components/_tcollector.mdx diff --git a/docs/zh/14-reference/_telegraf.mdx b/docs/zh/14-reference/01-components/_telegraf.mdx similarity index 100% rename from docs/zh/14-reference/_telegraf.mdx rename to docs/zh/14-reference/01-components/_telegraf.mdx diff --git a/docs/zh/20-third-party/01-collection/02-prometheus.md b/docs/zh/20-third-party/01-collection/02-prometheus.md index 8b8f29be93..33cf85dcd0 100644 --- a/docs/zh/20-third-party/01-collection/02-prometheus.md +++ b/docs/zh/20-third-party/01-collection/02-prometheus.md @@ -4,7 +4,7 @@ title: Prometheus description: 使用 Prometheus 访问 TDengine --- -import Prometheus from "../../14-reference/_prometheus.mdx" +import Prometheus from "../../14-reference//01-components/_prometheus.mdx" Prometheus 是一款流行的开源监控告警系统。Prometheus 于2016年加入了 Cloud Native Computing Foundation （云原生云计算基金会，简称 CNCF），成为继 Kubernetes 之后的第二个托管项目，该项目拥有非常活跃的开发人员和用户社区。 diff --git a/docs/zh/20-third-party/01-collection/03-telegraf.md b/docs/zh/20-third-party/01-collection/03-telegraf.md index 59b34b64e5..4f03595105 100644 --- a/docs/zh/20-third-party/01-collection/03-telegraf.md +++ b/docs/zh/20-third-party/01-collection/03-telegraf.md @@ -4,7 +4,7 @@ title: Telegraf 写入 description: 使用 Telegraf 向 TDengine 写入数据 --- -import Telegraf from "../../14-reference/_telegraf.mdx" +import Telegraf from "../../14-reference/01-components/_telegraf.mdx" Telegraf 是一款十分流行的指标采集开源软件。在数据采集和平台监控系统中，Telegraf 可以采集多种组件的运行信息，而不需要自己手写脚本定时采集，降低数据获取的难度。 diff --git a/docs/zh/20-third-party/01-collection/05-collectd.md b/docs/zh/20-third-party/01-collection/05-collectd.md index 4c0e22ebed..9d269af6c6 100644 --- a/docs/zh/20-third-party/01-collection/05-collectd.md +++ b/docs/zh/20-third-party/01-collection/05-collectd.md @@ -4,7 +4,7 @@ title: collectd 写入 description: 使用 collected 向 TDengine 写入数据 --- -import CollectD from "../../14-reference/_collectd.mdx" +import CollectD from "../../14-reference/01-components/_collectd.mdx" collectd 是一个用来收集系统性能的守护进程。collectd 提供各种存储方式来存储不同值的机制。它会在系统运行和存储信息时周期性的统计系统的相关统计信息。利用这些信息有助于查找当前系统性能瓶颈和预测系统未来的负载等。 diff --git a/docs/zh/20-third-party/01-collection/06-statsd.md b/docs/zh/20-third-party/01-collection/06-statsd.md index 06695972a4..a76a9e3f20 100644 --- a/docs/zh/20-third-party/01-collection/06-statsd.md +++ b/docs/zh/20-third-party/01-collection/06-statsd.md @@ -4,7 +4,7 @@ title: StatsD 直接写入 description: 使用 StatsD 向 TDengine 写入 --- -import StatsD from "../../14-reference/_statsd.mdx" +import StatsD from "../../14-reference/01-components/_statsd.mdx" StatsD 是汇总和总结应用指标的一个简单的守护进程，近些年来发展迅速，已经变成了一个用于收集应用性能指标的统一的协议。 diff --git a/docs/zh/20-third-party/01-collection/07-icinga2.md b/docs/zh/20-third-party/01-collection/07-icinga2.md index 3233a44c48..716397f2e6 100644 --- a/docs/zh/20-third-party/01-collection/07-icinga2.md +++ b/docs/zh/20-third-party/01-collection/07-icinga2.md @@ -4,7 +4,7 @@ title: icinga2 写入 description: 使用 icinga2 写入 TDengine --- -import Icinga2 from "../../14-reference/_icinga2.mdx" +import Icinga2 from "../../14-reference/01-components/_icinga2.mdx" icinga2 是一款开源主机、网络监控软件，最初由 Nagios 网络监控应用发展而来。目前，icinga2 遵从 GNU GPL v2 许可协议发行。 diff --git a/docs/zh/20-third-party/01-collection/08-tcollector.md b/docs/zh/20-third-party/01-collection/08-tcollector.md index 09d5f1e631..57f31204bf 100644 --- a/docs/zh/20-third-party/01-collection/08-tcollector.md +++ b/docs/zh/20-third-party/01-collection/08-tcollector.md @@ -4,7 +4,7 @@ title: TCollector 写入 description: 使用 TCollector 写入 TDengine --- -import TCollector from "../../14-reference/_tcollector.mdx" +import TCollector from "../../14-reference/01-components/_tcollector.mdx" TCollector 是 openTSDB 的一部分，它用来采集客户端日志发送给数据库。 diff --git a/docs/zh/20-third-party/01-collection/index.md b/docs/zh/20-third-party/01-collection/index.md index 4c66e136de..95b4271def 100644 --- a/docs/zh/20-third-party/01-collection/index.md +++ b/docs/zh/20-third-party/01-collection/index.md @@ -1,5 +1,12 @@ ---- -sidebar_label: 数据采集 -title: 与数据采集类工具的集成 -toc_max_heading_level: 4 ---- \ No newline at end of file +--- +sidebar_label: 数据采集 +title: 与数据采集类工具的集成 +toc_max_heading_level: 4 +--- + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/zh/20-third-party/03-visual/index.md b/docs/zh/20-third-party/03-visual/index.md index 96ee407b24..71518d2b04 100644 --- a/docs/zh/20-third-party/03-visual/index.md +++ b/docs/zh/20-third-party/03-visual/index.md @@ -1,5 +1,12 @@ ---- -sidebar_label: 可视化 -title: 与可视化工具的集成 -toc_max_heading_level: 4 ---- \ No newline at end of file +--- +sidebar_label: 可视化 +title: 与可视化工具的集成 +toc_max_heading_level: 4 +--- + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/zh/20-third-party/05-bi/index.md b/docs/zh/20-third-party/05-bi/index.md index bbf57dda23..d5867739d8 100644 --- a/docs/zh/20-third-party/05-bi/index.md +++ b/docs/zh/20-third-party/05-bi/index.md @@ -1,5 +1,12 @@ ---- -sidebar_label: 数据分析 -title: 与数据分析类工具的集成 -toc_max_heading_level: 4 ---- \ No newline at end of file +--- +sidebar_label: 数据分析 +title: 与数据分析类工具的集成 +toc_max_heading_level: 4 +--- + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file diff --git a/docs/zh/20-third-party/07-tool/index.md b/docs/zh/20-third-party/07-tool/index.md index e3c4ff8cec..7142e7d425 100644 --- a/docs/zh/20-third-party/07-tool/index.md +++ b/docs/zh/20-third-party/07-tool/index.md @@ -1,5 +1,12 @@ ---- -sidebar_label: 管理开发 -title: 与各种管理开发工具的集成 -toc_max_heading_level: 4 ---- \ No newline at end of file +--- +sidebar_label: 管理开发 +title: 与各种管理开发工具的集成 +toc_max_heading_level: 4 +--- + +```mdx-code-block +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + + +``` \ No newline at end of file