From ea8758b41515430adabf7fa7e0c487465d7db4df Mon Sep 17 00:00:00 2001 From: Dennis Zhuang Date: Thu, 20 Jun 2024 16:47:16 -0700 Subject: [PATCH 1/4] docs: tweak operation structures --- docs/nightly/en/summary.yml | 4 +++- docs/nightly/en/user-guide/operations/admin.md | 2 +- .../back-up-&-restore-data.md | 0 .../operations/disaster-recovery/overview.md | 3 +++ docs/nightly/en/user-guide/operations/overview.md | 10 ++++++---- docs/nightly/zh/summary-i18n.yml | 2 ++ docs/nightly/zh/user-guide/operations/admin.md | 2 +- .../back-up-&-restore-data.md | 0 .../operations/disaster-recovery/overview.md | 3 +++ docs/nightly/zh/user-guide/operations/overview.md | 12 +++++++++++- 10 files changed, 30 insertions(+), 8 deletions(-) rename docs/nightly/en/user-guide/operations/{ => disaster-recovery}/back-up-&-restore-data.md (100%) create mode 100644 docs/nightly/en/user-guide/operations/disaster-recovery/overview.md rename docs/nightly/zh/user-guide/operations/{ => disaster-recovery}/back-up-&-restore-data.md (100%) create mode 100644 docs/nightly/zh/user-guide/operations/disaster-recovery/overview.md diff --git a/docs/nightly/en/summary.yml b/docs/nightly/en/summary.yml index 807c91b9d..0fa202458 100644 --- a/docs/nightly/en/summary.yml +++ b/docs/nightly/en/summary.yml @@ -75,7 +75,9 @@ - admin - configuration - capacity-plan - - back-up-&-restore-data + - Disaster-Recovery + - overview + - back-up-&-restore-data - kubernetes - gtctl - run-on-android diff --git a/docs/nightly/en/user-guide/operations/admin.md b/docs/nightly/en/user-guide/operations/admin.md index 354987199..2208ce2cd 100644 --- a/docs/nightly/en/user-guide/operations/admin.md +++ b/docs/nightly/en/user-guide/operations/admin.md @@ -7,7 +7,7 @@ This document addresses strategies and practices used in the operation of Grepti * [Installation](/getting-started/installation/overview.md) for GreptimeDB and the [g-t-control](./gtctl.md) command line tool. * Database Configuration, please read the [Configuration](./configuration.md) reference. * [Monitoring](./monitoring.md) and [Tracing](./tracing.md) for GreptimeDB. -* GreptimeDB [Backup & Restore methods](./back-up-\&-restore-data.md). +* GreptimeDB [Disaster Recovery](./disaster-recovery/overview.md). ### Runtime information diff --git a/docs/nightly/en/user-guide/operations/back-up-&-restore-data.md b/docs/nightly/en/user-guide/operations/disaster-recovery/back-up-&-restore-data.md similarity index 100% rename from docs/nightly/en/user-guide/operations/back-up-&-restore-data.md rename to docs/nightly/en/user-guide/operations/disaster-recovery/back-up-&-restore-data.md diff --git a/docs/nightly/en/user-guide/operations/disaster-recovery/overview.md b/docs/nightly/en/user-guide/operations/disaster-recovery/overview.md new file mode 100644 index 000000000..f7ce128ce --- /dev/null +++ b/docs/nightly/en/user-guide/operations/disaster-recovery/overview.md @@ -0,0 +1,3 @@ +# Overview of GreptimeDB Disaster Recovery + +* [Backup & restore data](./back-up-&-restore-data.md) \ No newline at end of file diff --git a/docs/nightly/en/user-guide/operations/overview.md b/docs/nightly/en/user-guide/operations/overview.md index 8f05d624a..a22941a66 100644 --- a/docs/nightly/en/user-guide/operations/overview.md +++ b/docs/nightly/en/user-guide/operations/overview.md @@ -1,11 +1,13 @@ # Operations +* [Administration](./admin.md) * [Configuration](./configuration.md) +* [Capacity Plan](./capacity-plan.md) +* [Disaster Recovery](./disaster-recovery/overview.md) * [Kubernetes](./kubernetes.md) * [gtctl](./gtctl.md) +* [Running on Android](./run-on-android.md) * [Monitoring](./monitoring.md) * [Tracing](./tracing.md) - \ No newline at end of file +* [Remote WAL](./remote-wal/quick-start.md) +* [Region Migration](./region-migration.md) diff --git a/docs/nightly/zh/summary-i18n.yml b/docs/nightly/zh/summary-i18n.yml index 2f56a23a5..946482be9 100644 --- a/docs/nightly/zh/summary-i18n.yml +++ b/docs/nightly/zh/summary-i18n.yml @@ -34,3 +34,5 @@ SDK: SDK SQL: SQL FAQ-and-Others: 常见问题及其他 Release-Notes: Release Notes +Disaster-Recovery: 灾难恢复 +Upgrade: 升级 diff --git a/docs/nightly/zh/user-guide/operations/admin.md b/docs/nightly/zh/user-guide/operations/admin.md index 90aceb389..5cf8c6ad8 100644 --- a/docs/nightly/zh/user-guide/operations/admin.md +++ b/docs/nightly/zh/user-guide/operations/admin.md @@ -7,7 +7,7 @@ * GreptimeDB 的 [安装](/getting-started/installation/overview.md) 和 [g-t-control](./gtctl.md) 命令行工具。 * 数据库配置，请阅读 [配置](./configuration.md) 参考。 * GreptimeDB 的 [监控](./monitoring.md) 和 [链路追踪](./tracing.md)。 -* GreptimeDB 的 [备份与恢复方法](./back-up-\&-restore-data.md)。 +* GreptimeDB 的 [灾难恢复方案](./disaster-recovery/overview.md)。 ### 运行时信息 diff --git a/docs/nightly/zh/user-guide/operations/back-up-&-restore-data.md b/docs/nightly/zh/user-guide/operations/disaster-recovery/back-up-&-restore-data.md similarity index 100% rename from docs/nightly/zh/user-guide/operations/back-up-&-restore-data.md rename to docs/nightly/zh/user-guide/operations/disaster-recovery/back-up-&-restore-data.md diff --git a/docs/nightly/zh/user-guide/operations/disaster-recovery/overview.md b/docs/nightly/zh/user-guide/operations/disaster-recovery/overview.md new file mode 100644 index 000000000..0ae99e41d --- /dev/null +++ b/docs/nightly/zh/user-guide/operations/disaster-recovery/overview.md @@ -0,0 +1,3 @@ +# GreptimeDB 灾难恢复介绍 + +* GreptimeDB 的 [备份与恢复方法](./back-up-\&-restore-data.md) \ No newline at end of file diff --git a/docs/nightly/zh/user-guide/operations/overview.md b/docs/nightly/zh/user-guide/operations/overview.md index 1333ed77b..7d49a80b4 100644 --- a/docs/nightly/zh/user-guide/operations/overview.md +++ b/docs/nightly/zh/user-guide/operations/overview.md @@ -1 +1,11 @@ -TODO +* [管理](./admin.md) +* [配置 GreptimeDB](./configuration.md) +* [容量规划](./capacity-plan.md) +* [灾难恢复](./disaster-recovery/overview.md) +* [Kubernetes](./kubernetes.md) +* [gtctl](./gtctl.md) +* [在 Android 平台运行](./run-on-android.md) +* [监控](./monitoring.md) +* [Tracing](./tracing.md) +* [Remote WAL](./remote-wal/quick-start.md) +* [Region 迁移](./region-migration.md) From bfa25f891e5a7d2c321a13ef88204c45d841b6ca Mon Sep 17 00:00:00 2001 From: Dennis Zhuang Date: Thu, 20 Jun 2024 16:51:07 -0700 Subject: [PATCH 2/4] fix: broken links to emqx doc --- docs/nightly/en/user-guide/clients/emqx.md | 2 +- docs/nightly/zh/user-guide/clients/emqx.md | 2 +- docs/v0.8/en/user-guide/clients/emqx.md | 2 +- docs/v0.8/zh/user-guide/clients/emqx.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/nightly/en/user-guide/clients/emqx.md b/docs/nightly/en/user-guide/clients/emqx.md index 4e0050501..5c7b57246 100644 --- a/docs/nightly/en/user-guide/clients/emqx.md +++ b/docs/nightly/en/user-guide/clients/emqx.md @@ -2,4 +2,4 @@ [EMQX](https://www.emqx.io/) is an open-source, highly scalable, and feature-rich MQTT broker designed for IoT and real-time messaging applications. It supports various protocols, including MQTT (3.1, 3.1.1, and 5.0), HTTP, QUIC, and WebSocket. -GreptimeDB can be used as a data system for EMQX. To learn how to integrate GreptimeDB with EMQX, please refer to [Ingest MQTT Data into GreptimeDB](https://www.emqx.io/docs/en/v5/data-integration/data-bridge-greptimedb.html). +GreptimeDB can be used as a data system for EMQX. To learn how to integrate GreptimeDB with EMQX, please refer to [Ingest MQTT Data into GreptimeDB](https://docs.emqx.com/en/emqx/latest/data-integration/data-bridge-greptimedb.html). diff --git a/docs/nightly/zh/user-guide/clients/emqx.md b/docs/nightly/zh/user-guide/clients/emqx.md index 435143afb..eaee3e802 100644 --- a/docs/nightly/zh/user-guide/clients/emqx.md +++ b/docs/nightly/zh/user-guide/clients/emqx.md @@ -2,4 +2,4 @@ [EMQX](https://www.emqx.io/) 是一款开源的大规模分布式 MQTT 消息服务器，专为物联网和实时通信应用而设计。EMQX 支持多种协议，包括 MQTT (3.1、3.1.1 和 5.0)、HTTP、QUIC 和 WebSocket 等，保证各种网络环境和硬件设备的可访问性。 -GreptimeDB 可以作为 EMQX 的数据系统。请参考[将 MQTT 数据写入 GreptimeDB](https://www.emqx.io/docs/zh/v5/data-integration/data-bridge-greptimedb.html) 了解如何将 GreptimeDB 集成到 EMQX 中。 +GreptimeDB 可以作为 EMQX 的数据系统。请参考[将 MQTT 数据写入 GreptimeDB](https://docs.emqx.com/zh/emqx/latest/data-integration/data-bridge-greptimedb.html) 了解如何将 GreptimeDB 集成到 EMQX 中。 diff --git a/docs/v0.8/en/user-guide/clients/emqx.md b/docs/v0.8/en/user-guide/clients/emqx.md index 4e0050501..5c7b57246 100644 --- a/docs/v0.8/en/user-guide/clients/emqx.md +++ b/docs/v0.8/en/user-guide/clients/emqx.md @@ -2,4 +2,4 @@ [EMQX](https://www.emqx.io/) is an open-source, highly scalable, and feature-rich MQTT broker designed for IoT and real-time messaging applications. It supports various protocols, including MQTT (3.1, 3.1.1, and 5.0), HTTP, QUIC, and WebSocket. -GreptimeDB can be used as a data system for EMQX. To learn how to integrate GreptimeDB with EMQX, please refer to [Ingest MQTT Data into GreptimeDB](https://www.emqx.io/docs/en/v5/data-integration/data-bridge-greptimedb.html). +GreptimeDB can be used as a data system for EMQX. To learn how to integrate GreptimeDB with EMQX, please refer to [Ingest MQTT Data into GreptimeDB](https://docs.emqx.com/en/emqx/latest/data-integration/data-bridge-greptimedb.html). diff --git a/docs/v0.8/zh/user-guide/clients/emqx.md b/docs/v0.8/zh/user-guide/clients/emqx.md index 435143afb..eaee3e802 100644 --- a/docs/v0.8/zh/user-guide/clients/emqx.md +++ b/docs/v0.8/zh/user-guide/clients/emqx.md @@ -2,4 +2,4 @@ [EMQX](https://www.emqx.io/) 是一款开源的大规模分布式 MQTT 消息服务器，专为物联网和实时通信应用而设计。EMQX 支持多种协议，包括 MQTT (3.1、3.1.1 和 5.0)、HTTP、QUIC 和 WebSocket 等，保证各种网络环境和硬件设备的可访问性。 -GreptimeDB 可以作为 EMQX 的数据系统。请参考[将 MQTT 数据写入 GreptimeDB](https://www.emqx.io/docs/zh/v5/data-integration/data-bridge-greptimedb.html) 了解如何将 GreptimeDB 集成到 EMQX 中。 +GreptimeDB 可以作为 EMQX 的数据系统。请参考[将 MQTT 数据写入 GreptimeDB](https://docs.emqx.com/zh/emqx/latest/data-integration/data-bridge-greptimedb.html) 了解如何将 GreptimeDB 集成到 EMQX 中。 From f134eada5443e3c31e20bdadba9b9ba10b5cf482 Mon Sep 17 00:00:00 2001 From: Dennis Zhuang Date: Thu, 20 Jun 2024 16:56:22 -0700 Subject: [PATCH 3/4] fix: summary --- docs/nightly/en/summary.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/nightly/en/summary.yml b/docs/nightly/en/summary.yml index 0fa202458..0bdda7999 100644 --- a/docs/nightly/en/summary.yml +++ b/docs/nightly/en/summary.yml @@ -75,7 +75,7 @@ - admin - configuration - capacity-plan - - Disaster-Recovery + - Disaster-Recovery: - overview - back-up-&-restore-data - kubernetes From 30c144fa32357b5512aebea83a03e1d998c41225 Mon Sep 17 00:00:00 2001 From: Yiran Date: Fri, 21 Jun 2024 11:54:09 +0800 Subject: [PATCH 4/4] Apply suggestions from code review --- .../en/user-guide/operations/disaster-recovery/overview.md | 2 +- .../zh/user-guide/operations/disaster-recovery/overview.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/nightly/en/user-guide/operations/disaster-recovery/overview.md b/docs/nightly/en/user-guide/operations/disaster-recovery/overview.md index f7ce128ce..bbf8186b5 100644 --- a/docs/nightly/en/user-guide/operations/disaster-recovery/overview.md +++ b/docs/nightly/en/user-guide/operations/disaster-recovery/overview.md @@ -1,3 +1,3 @@ -# Overview of GreptimeDB Disaster Recovery +# Overview * [Backup & restore data](./back-up-&-restore-data.md) \ No newline at end of file diff --git a/docs/nightly/zh/user-guide/operations/disaster-recovery/overview.md b/docs/nightly/zh/user-guide/operations/disaster-recovery/overview.md index 0ae99e41d..ea9cae76c 100644 --- a/docs/nightly/zh/user-guide/operations/disaster-recovery/overview.md +++ b/docs/nightly/zh/user-guide/operations/disaster-recovery/overview.md @@ -1,3 +1,3 @@ -# GreptimeDB 灾难恢复介绍 +# 概述 * GreptimeDB 的 [备份与恢复方法](./back-up-\&-restore-data.md) \ No newline at end of file