morrySnow commented on code in PR #1891:
URL: https://github.com/apache/doris-website/pull/1891#discussion_r1926316159
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/ALTER-STORAGE-POLICY.md:
##########
@@ -29,10 +29,10 @@ under the License.
## 描述
该语句用于修改一个已有的冷热分层迁移策略。仅 root 或 admin 用户可以修改资源。
-语法：
+
+## 语法
```sql
-ALTER STORAGE POLICY 'policy_name'
-PROPERTIES ("key"="value", ...);
+ALTER STORAGE POLICY 'policy_name' PROPERTIES ("key"="value", ...);
```
Review Comment:
缺少参数描述部分
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/ALTER-STORAGE-POLICY.md:
##########
@@ -29,10 +29,10 @@ under the License.
## 描述
该语句用于修改一个已有的冷热分层迁移策略。仅 root 或 admin 用户可以修改资源。
-语法：
+
+## 语法
```sql
-ALTER STORAGE POLICY 'policy_name'
-PROPERTIES ("key"="value", ...);
+ALTER STORAGE POLICY 'policy_name' PROPERTIES ("key"="value", ...);
Review Comment:
1. 参数需要尖括号包裹
2. 变长参数部分，应该用方括号包裹
```suggestion
ALTER STORAGE POLICY "<policy_name>" PROPERTIES ("<key>"="<value>" [, ... ]);
```
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/SET-DEFAULT-STORAGE-VAULT.md:
##########
@@ -34,8 +34,7 @@ under the License.
SET vault_name DEFAULT STORAGE VAULT
Review Comment:
```suggestion
SET <vault_name> DEFAULT STORAGE VAULT
```
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/CREATE-STORAGE-VAULT.md:
##########
@@ -26,24 +26,26 @@ specific language governing permissions and limitations
under the License.
-->
-## CREATE-STORAGE-VAULT
-
## 描述
该命令用于创建存储库。本文档的主题描述了创建 Doris 自管理存储库的语法。
+
+## 语法
+
```sql
CREATE STORAGE VAULT [IF NOT EXISTS] vault
[properties]
```
-#### properties
+## 参数
| 参数 | 是否必需 | 描述 |
|:-------|:-----|:-----------------------|
Review Comment:
这是参数 properties 的 key 的可选范围。
参数需要先写 `<properties>`，介绍 properties 的用处。
然后再介绍 properties 时，再用另外一个表格介绍 properties 的 key 都的可选范围。
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/CREATE-STORAGE-VAULT.md:
##########
@@ -26,24 +26,26 @@ specific language governing permissions and limitations
under the License.
-->
-## CREATE-STORAGE-VAULT
-
## 描述
该命令用于创建存储库。本文档的主题描述了创建 Doris 自管理存储库的语法。
+
+## 语法
+
```sql
CREATE STORAGE VAULT [IF NOT EXISTS] vault
[properties]
Review Comment:
```suggestion
[ <properties> ]
```
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md:
##########
@@ -30,7 +30,7 @@ under the License.
查看所有/指定存储策略关联的表和分区
-语法：
+## 语法
```sql
SHOW STORAGE POLICY USING [FOR some_policy]
Review Comment:
缺少参数章节
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md:
##########
@@ -40,7 +40,7 @@ SHOW STORAGE POLICY USING [FOR some_policy]
1. 查看所有启用了存储策略的对象
```sql
- mysql> show storage policy using;
+ show storage policy using;
Review Comment:
查询和结果要放到两个 code block 中
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/SET-DEFAULT-STORAGE-VAULT.md:
##########
@@ -34,8 +34,7 @@ under the License.
SET vault_name DEFAULT STORAGE VAULT
```
Review Comment:
缺少参数章节
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md:
##########
@@ -30,7 +30,7 @@ under the License.
查看所有/指定存储策略关联的表和分区
-语法：
+## 语法
```sql
SHOW STORAGE POLICY USING [FOR some_policy]
Review Comment:
```suggestion
SHOW STORAGE POLICY USING [FOR <some_policy>]
```
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/SHOW-CACHE-HOTSPOT.md:
##########
@@ -36,26 +36,20 @@ under the License.
Review Comment:
语法中的参数需要尖括号包裹
```sql
SHOW CACHE HOTSPOT '/[<compute_group_name>/<table_name>]';
```
##########
i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/SHOW-CACHE-HOTSPOT.md:
##########
@@ -36,26 +36,20 @@ under the License.
## 参数
-* compute_group_name : 计算组的名称。
-* table_name : 表的名称。
-
+| 参数名称 | 描述
|
+|---------------------------|--------------------------------------------------------------|
+| compute_group_name | 计算组的名称。
|
+| table_name | 表的名称。
|
Review Comment:
```suggestion
| <compute_group_name> | 计算组的名称。
|
| <table_name> | 表的名称。
|
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
