Move Noop WAL to separate page and reduce use of info/warning boxes

Copilot · WenyXu · Copilot · commit 6a9aba8a579b · 2025-10-20T09:52:32.000Z
Co-authored-by: WenyXu &lt;32535939+WenyXu@users.noreply.github.com&gt;
diff --git a/docs/user-guide/deployments-administration/wal/local-wal.md b/docs/user-guide/deployments-administration/wal/local-wal.md
@@ -22,46 +22,14 @@ If you are using Helm Chart to deploy GreptimeDB, you can refer to [Common Helm
 
 | Configuration Option | Description                                                                                                          | Default Value     |
 | -------------------- | -------------------------------------------------------------------------------------------------------------------- | ----------------- |
-| `provider`           | The provider of the WAL. Options: `raft_engine` (local file system storage), `kafka` (remote WAL storage in Kafka), or `noop` (no-op WAL provider) | `"raft_engine"`   |
+| `provider`           | The provider of the WAL. Options: `raft_engine` (local file system storage), `kafka` (remote WAL storage in Kafka), or `noop` (no-op WAL provider, see [Noop WAL](/user-guide/deployments-administration/wal/noop-wal.md)) | `"raft_engine"`   |
 | `dir`                | The directory where to write logs                                                                                    | `{data_home}/wal` |
 | `file_size`          | The size of single WAL log file                                                                                      | `128MB`           |
 | `purge_threshold`    | The threshold of the WAL size to trigger purging                                                                     | `1GB`             |
 | `purge_interval`     | The interval to trigger purging                                                                                      | `1m`              |
 | `read_batch_size`    | The read batch size                                                                                                  | `128`             |
 | `sync_write`         | Whether to call fsync when writing every log                                                                         | `false`           |
 
-## Noop WAL Configuration
-
-The Noop WAL provider is a special WAL option designed for emergency situations where the normal WAL provider becomes unavailable.
-
-:::info
-Noop WAL is **only available in distributed (cluster) mode**, not in standalone mode.
-:::
-
-### Configuration
-
-To configure Noop WAL for a Datanode in a cluster:
-
-```toml
-[wal]
-provider = "noop"
-```
-
-:::danger DATA LOSS WARNING
-When using Noop WAL:
-- **All unflushed data will be lost** when the Datanode is shutdown or restarted.
-- This provider should **only be used temporarily** when the normal WAL provider is unavailable.
-- **Not recommended for production use** except in emergency situations.
-:::
-
-### Important Notes
-
-- **Noop WAL is only available in distributed (cluster) mode.** It cannot be used in standalone mode.
-- **Noop WAL cannot be configured on Metasrv.** It is only available for Datanode configuration. The Metasrv WAL provider should be set to either `raft_engine` or `kafka`.
-- When switching to Noop WAL, ensure that you have a data recovery plan in place.
-- To minimize data loss, flush regions regularly using `admin flush_table()` or `admin flush_region()`.
-- Once the normal WAL provider is available again, switch back to using it as soon as possible.
-
 ## Best practices
 
 ### Using a separate High-Performance Volume for WAL
diff --git a/docs/user-guide/deployments-administration/wal/noop-wal.md b/docs/user-guide/deployments-administration/wal/noop-wal.md
@@ -0,0 +1,45 @@
+---
+keywords: [Configuration, Noop WAL, GreptimeDB Datanode, GreptimeDB, cluster mode]
+description: This section describes how to configure the Noop WAL for GreptimeDB Datanode component in cluster mode.
+---
+# Noop WAL
+
+Noop WAL is a special WAL provider designed for emergency situations where the configured WAL provider becomes temporarily unavailable. It is a no-operation WAL provider that does not actually store any WAL data.
+
+## Availability
+
+Noop WAL is **only available in distributed (cluster) mode**, not in standalone mode.
+
+## Use Cases
+
+- **Temporary WAL Unavailability**: When your configured WAL provider (e.g., Kafka) becomes temporarily unavailable, you can switch the Datanode to use Noop WAL to keep the cluster operational.
+- **Testing and Development**: Useful for testing scenarios where WAL persistence is not required.
+
+## Data Loss Warning
+
+**When using Noop WAL, all unflushed data will be lost when the Datanode is shutdown or restarted.** This provider should only be used temporarily when the normal WAL provider is unavailable and is not recommended for production use except in emergency situations.
+
+## Configuration
+
+To configure Noop WAL for a Datanode in a cluster:
+
+```toml
+[wal]
+provider = "noop"
+```
+
+In a GreptimeDB cluster, WAL provider configuration is needed in two places:
+
+1. **Metasrv** - Responsible for generating WAL provider metadata for new regions. The Metasrv WAL provider should be set to either `raft_engine` or `kafka`. Noop WAL cannot be configured on Metasrv.
+2. **Datanode** - Responsible for reading and writing WAL data. This is where you configure Noop WAL.
+
+When the WAL provider is temporarily unavailable, you only need to configure the Datanode's WAL provider as `noop` to keep the cluster functional. The Metasrv continues using its configured WAL provider (`raft_engine` or `kafka`).
+
+## Important Notes
+
+- Noop WAL is only available in distributed (cluster) mode. It cannot be used in standalone mode.
+- Noop WAL cannot be configured on Metasrv. It is only available for Datanode configuration.
+- The Metasrv WAL provider should be set to either `raft_engine` or `kafka`.
+- When switching to Noop WAL, ensure that you have a data recovery plan in place.
+- To minimize data loss, flush regions regularly using `admin flush_table()` or `admin flush_region()`.
+- Once the normal WAL provider is available again, switch back to using it as soon as possible.
diff --git a/docs/user-guide/deployments-administration/wal/overview.md b/docs/user-guide/deployments-administration/wal/overview.md
@@ -44,39 +44,21 @@ The [Write-Ahead Logging](/contributor-guide/datanode/wal.md#introduction)(WAL)
 
 ## Noop WAL
 
-Noop WAL is a special WAL provider designed for situations where the configured WAL provider becomes temporarily unavailable. It is a no-operation WAL provider that does not actually store any WAL data.
+Noop WAL is a special WAL provider designed for situations where the configured WAL provider becomes temporarily unavailable. It is a no-operation WAL provider that does not actually store any WAL data. Noop WAL is only available in distributed (cluster) mode, not in standalone mode.
 
-:::info
-Noop WAL is **only available in distributed (cluster) mode**, not in standalone mode.
-:::
+### Key Characteristics
 
-### Use Cases
+- **No Data Persistence**: Does not store any WAL data.
+- **Data Loss Risk**: All unflushed data will be lost when the Datanode is shutdown or restarted.
+- **Temporary Use Only**: Should only be used temporarily when the normal WAL provider is unavailable.
+- **Cluster Mode Only**: Only available in distributed (cluster) mode, not in standalone mode.
 
-- **Temporary WAL Unavailability**: When your configured WAL provider (e.g., Kafka) becomes temporarily unavailable, you can switch the Datanode to use Noop WAL to keep the cluster operational.
-- **Testing and Development**: Useful for testing scenarios where WAL persistence is not required.
-
-### Important Warnings
-
-:::danger DATA LOSS WARNING
-When using Noop WAL:
-- **All unflushed data will be lost** when the Datanode is shutdown or restarted.
-- This provider should **only be used temporarily** when the normal WAL provider is unavailable.
-- **Not recommended for production use** except in emergency situations.
-:::
-
-### Configuration
-
-In a GreptimeDB cluster, WAL provider configuration is needed in two places:
-
-1. **Metasrv** - Responsible for generating WAL provider metadata for new regions. The Metasrv WAL provider should be set to either `raft_engine` or `kafka`. **Noop WAL cannot be configured on Metasrv.**
-2. **Datanode** - Responsible for reading and writing WAL data. This is where you configure Noop WAL.
-
-When the WAL provider is temporarily unavailable, you only need to configure the Datanode's WAL provider as `noop` to keep the cluster functional. The Metasrv continues using its configured WAL provider (`raft_engine` or `kafka`).
-
-For configuration details, see the [Local WAL configuration page](/user-guide/deployments-administration/wal/local-wal.md#noop-wal-configuration).
+For detailed configuration and usage information, see the [Noop WAL](/user-guide/deployments-administration/wal/noop-wal.md) page.
 
 ## Next steps
 
 - To configure the Local WAL storage, please refer to [Local WAL](/user-guide/deployments-administration/wal/local-wal.md).
 
-- To learn more about the Remote WAL, please refer to [Remote WAL](/user-guide/deployments-administration/wal/remote-wal/configuration.md).
+- To learn more about the Remote WAL, please refer to [Remote WAL](/user-guide/deployments-administration/wal/remote-wal/configuration.md).
+
+- To learn more about the Noop WAL, please refer to [Noop WAL](/user-guide/deployments-administration/wal/noop-wal.md).
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/wal/local-wal.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/wal/local-wal.md
@@ -23,46 +23,14 @@ sync_write = false
 
 | 配置项            | 描述                                                                                            | 默认值            |
 | ----------------- | ----------------------------------------------------------------------------------------------- | ----------------- |
-| `provider`        | WAL 的提供者。可选项：`raft_engine`（本地文件系统存储）、`kafka`（使用 Kafka 的远程 WAL 存储）或 `noop`（无操作 WAL 提供者） | `"raft_engine"`   |
+| `provider`        | WAL 的提供者。可选项：`raft_engine`（本地文件系统存储）、`kafka`（使用 Kafka 的远程 WAL 存储）或 `noop`（无操作 WAL 提供者，参见 [Noop WAL](/user-guide/deployments-administration/wal/noop-wal.md)） | `"raft_engine"`   |
 | `dir`             | 日志写入目录                                                                                    | `{data_home}/wal` |
 | `file_size`       | 单个 WAL 日志文件的大小                                                                         | `128MB`           |
 | `purge_threshold` | 触发清理的 WAL 总大小阈值                                                                       | `1GB`             |
 | `purge_interval`  | 触发清理的时间间隔                                                                              | `1m`              |
 | `read_batch_size` | 读取批次大小                                                                                    | `128`             |
 | `sync_write`      | 是否在每次写入日志时调用 fsync                                                                  | `false`           |
 
-## Noop WAL 配置
-
-Noop WAL 提供者是专为正常 WAL 提供者不可用的紧急情况而设计的特殊 WAL 选项。
-
-:::info
-Noop WAL **仅在分布式（集群）模式下可用**，不适用于单机模式。
-:::
-
-### 配置
-
-要为集群中的 Datanode 配置 Noop WAL：
-
-```toml
-[wal]
-provider = "noop"
-```
-
-:::danger 数据丢失警告
-使用 Noop WAL 时:
-- **所有未刷新的数据**将在 Datanode 关闭或重启时**丢失**。
-- 此提供者应**仅在正常 WAL 提供者不可用时临时使用**。
-- **不建议在生产环境中使用**，除非是紧急情况。
-:::
-
-### 重要提示
-
-- **Noop WAL 仅在分布式（集群）模式下可用。** 它不能在单机模式下使用。
-- **Noop WAL 不能在 Metasrv 上配置。** 它仅适用于 Datanode 配置。Metasrv 的 WAL 提供者应设置为 `raft_engine` 或 `kafka`。
-- 切换到 Noop WAL 时，请确保有数据恢复计划。
-- 为了最小化数据丢失，请使用 `admin flush_table()` 或 `admin flush_region()` 定期刷新 Region。
-- 一旦正常 WAL 提供者恢复可用，请尽快切换回使用它。
-
 ## 最佳实践
 
 ### 使用单独的高性能卷作为 WAL 目录
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/wal/noop-wal.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/wal/noop-wal.md
@@ -0,0 +1,45 @@
+---
+keywords: [配置, Noop WAL, GreptimeDB Datanode, GreptimeDB, 集群模式]
+description: 介绍如何在集群模式下为 GreptimeDB Datanode 组件配置 Noop WAL。
+---
+# Noop WAL
+
+Noop WAL 是专为配置的 WAL 提供者暂时不可用的情况而设计的特殊 WAL 提供者。它是一个无操作 WAL 提供者，实际上不存储任何 WAL 数据。
+
+## 可用性
+
+Noop WAL **仅在分布式（集群）模式下可用**，不适用于单机模式。
+
+## 使用场景
+
+- **WAL 暂时不可用**: 当您配置的 WAL 提供者（例如 Kafka）暂时不可用时，可以将 Datanode 切换为使用 Noop WAL，以保持集群的运行。
+- **测试和开发**: 适用于不需要 WAL 持久化的测试场景。
+
+## 数据丢失警告
+
+**使用 Noop WAL 时，所有未刷新的数据将在 Datanode 关闭或重启时丢失。** 此提供者应仅在正常 WAL 提供者不可用时临时使用，不建议在生产环境中使用，除非是紧急情况。
+
+## 配置
+
+要为集群中的 Datanode 配置 Noop WAL：
+
+```toml
+[wal]
+provider = "noop"
+```
+
+在 GreptimeDB 集群中，WAL 提供者配置需要在两个地方进行:
+
+1. **Metasrv** - 负责为新 Region 生成 WAL 提供者元数据。Metasrv 的 WAL 提供者应设置为 `raft_engine` 或 `kafka`。Noop WAL 不能在 Metasrv 上配置。
+2. **Datanode** - 负责读写 WAL 数据。这是配置 Noop WAL 的地方。
+
+当 WAL 提供者暂时不可用时，您只需将 Datanode 的 WAL 提供者配置为 `noop` 即可保持集群正常运行。Metasrv 继续使用其配置的 WAL 提供者（`raft_engine` 或 `kafka`）。
+
+## 重要提示
+
+- Noop WAL 仅在分布式（集群）模式下可用。它不能在单机模式下使用。
+- Noop WAL 不能在 Metasrv 上配置。它仅适用于 Datanode 配置。
+- Metasrv 的 WAL 提供者应设置为 `raft_engine` 或 `kafka`。
+- 切换到 Noop WAL 时，请确保有数据恢复计划。
+- 为了最小化数据丢失，请使用 `admin flush_table()` 或 `admin flush_region()` 定期刷新 Region。
+- 一旦正常 WAL 提供者恢复可用，请尽快切换回使用它。
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/wal/overview.md b/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/wal/overview.md
@@ -47,39 +47,21 @@ description: 介绍 GreptimeDB 中的 WAL（预写日志），包括本地 WAL 
 
 ## Noop WAL
 
-Noop WAL 是专为配置的 WAL 提供者暂时不可用的情况而设计的特殊 WAL 提供者。它是一个无操作 WAL 提供者，实际上不存储任何 WAL 数据。
+Noop WAL 是专为配置的 WAL 提供者暂时不可用的情况而设计的特殊 WAL 提供者。它是一个无操作 WAL 提供者，实际上不存储任何 WAL 数据。Noop WAL 仅在分布式（集群）模式下可用，不适用于单机模式。
 
-:::info
-Noop WAL **仅在分布式（集群）模式下可用**，不适用于单机模式。
-:::
+### 主要特性
 
-### 使用场景
+- **无数据持久化**: 不存储任何 WAL 数据。
+- **数据丢失风险**: 所有未刷新的数据将在 Datanode 关闭或重启时丢失。
+- **仅临时使用**: 应仅在正常 WAL 提供者不可用时临时使用。
+- **仅限集群模式**: 仅在分布式（集群）模式下可用，不适用于单机模式。
 
-- **WAL 暂时不可用**: 当您配置的 WAL 提供者（例如 Kafka）暂时不可用时，可以将 Datanode 切换为使用 Noop WAL，以保持集群的运行。
-- **测试和开发**: 适用于不需要 WAL 持久化的测试场景。
-
-### 重要警告
-
-:::danger 数据丢失警告
-使用 Noop WAL 时:
-- **所有未刷新的数据**将在 Datanode 关闭或重启时**丢失**。
-- 此提供者应**仅在正常 WAL 提供者不可用时临时使用**。
-- **不建议在生产环境中使用**，除非是紧急情况。
-:::
-
-### 配置
-
-在 GreptimeDB 集群中，WAL 提供者配置需要在两个地方进行:
-
-1. **Metasrv** - 负责为新 Region 生成 WAL 提供者元数据。Metasrv 的 WAL 提供者应设置为 `raft_engine` 或 `kafka`。**Noop WAL 不能在 Metasrv 上配置。**
-2. **Datanode** - 负责读写 WAL 数据。这是配置 Noop WAL 的地方。
-
-当 WAL 提供者暂时不可用时，您只需将 Datanode 的 WAL 提供者配置为 `noop` 即可保持集群正常运行。Metasrv 继续使用其配置的 WAL 提供者（`raft_engine` 或 `kafka`）。
-
-有关配置详情，请参阅[本地 WAL 配置页面](/user-guide/deployments-administration/wal/local-wal.md#noop-wal-配置)。
+有关详细配置和使用信息，请参阅 [Noop WAL](/user-guide/deployments-administration/wal/noop-wal.md) 页面。
 
 ## 后续步骤
 
 - 如需配置本地 WAL 存储，请参阅[本地 WAL](/user-guide/deployments-administration/wal/local-wal.md)。
 
-- 想了解更多 Remote WAL 相关信息，请参阅 [Remote WAL](/user-guide/deployments-administration/wal/remote-wal/configuration.md)。
+- 想了解更多 Remote WAL 相关信息，请参阅 [Remote WAL](/user-guide/deployments-administration/wal/remote-wal/configuration.md)。
+
+- 想了解更多 Noop WAL 相关信息，请参阅 [Noop WAL](/user-guide/deployments-administration/wal/noop-wal.md)。
diff --git a/sidebars.ts b/sidebars.ts
@@ -313,6 +313,7 @@ const sidebars: SidebarsConfig = {
                     'user-guide/deployments-administration/wal/remote-wal/manage-kafka',
                   ]
                 },
+                'user-guide/deployments-administration/wal/noop-wal',
               ],
             },
             'user-guide/deployments-administration/configuration',

Original file line number	Diff line number	Diff line change
`@@ -313,6 +313,7 @@ const sidebars: SidebarsConfig = {`
`313`	`313`	`'user-guide/deployments-administration/wal/remote-wal/manage-kafka',`
`314`	`314`	`]`
`315`	`315`	`},`
	`316`	`+ 'user-guide/deployments-administration/wal/noop-wal',`
`316`	`317`	`],`
`317`	`318`	`},`
`318`	`319`	`'user-guide/deployments-administration/configuration',`