morrySnow commented on code in PR #1823:
URL: https://github.com/apache/doris-website/pull/1823#discussion_r1923031658
##########
docs/sql-manual/sql-statements/cluster-management/compute-management/ALTER-RESOURCE.md:
##########
@@ -25,24 +25,25 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
-
-
## Description
This statement is used to modify an existing resource. Only the root or admin
user can modify resources.
-Syntax:
+
+## Syntax
```sql
ALTER RESOURCE 'resource_name'
-PROPERTIES ("key"="value", ...);
+PROPERTIES (
+ "<key>"="<value>",
+ ...
+);
```
Review Comment:
缺少参数章节
##########
docs/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-GROUP.md:
##########
@@ -24,35 +24,38 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
-
-
## Description
This statement is used to create a workload group. Workload groups enable the
isolation of cpu resources and memory resources on a single be.
-grammar:
+## Syntax
```sql
CREATE WORKLOAD GROUP [IF NOT EXISTS] "rg_name"
PROPERTIES (
- property_list
+ "<key>"="<value>",
+ ...
Review Comment:
```suggestion
"<key>" = "<value>"
[ , ... ]
```
##########
docs/sql-manual/sql-statements/cluster-management/compute-management/CREATE-RESOURCE.md:
##########
@@ -24,30 +24,30 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
-
## Description
This statement is used to create a resource. Only the root or admin user can
create resources. Currently supports Spark, ODBC, S3 external resources.
In the future, other external resources may be added to Doris for use, such as
Spark/GPU for query, HDFS/S3 for external storage, MapReduce for ETL, etc.
-grammar:
+## Syntax
```sql
CREATE [EXTERNAL] RESOURCE "resource_name"
-PROPERTIES ("key"="value", ...);
+PROPERTIES (
+ "<key>"="<value>",
+ ...
+);
```
-illustrate:
+## Required Parameters
+1. `<type>`
+The type of resource needs to be specified in PROPERTIES "type" =
"[spark|odbc_catalog|s3|jdbc|hdfs|hms|es]".
Review Comment:
语法中不存在`<type>`
##########
docs/sql-manual/sql-statements/cluster-management/compute-management/ALTER-WORKLOAD-GROUP.md:
##########
@@ -24,27 +24,26 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## Description
This statement is used to modify the workload group.
-Syntax:
+## Syntax
```sql
ALTER WORKLOAD GROUP "rg_name"
PROPERTIES (
- property_list
+ "<key>"="<value>",
+ ...
);
```
Review Comment:
缺少参数章节
##########
docs/sql-manual/sql-statements/cluster-management/compute-management/DROP-WORKLOAD-GROUP.md:
##########
@@ -25,27 +25,20 @@ under the License.
-->
-
-
## Description
This statement is used to delete a workload group.
+## Syntax
+
```sql
DROP WORKLOAD GROUP [IF EXISTS] 'rg_name'
Review Comment:
```suggestion
DROP WORKLOAD GROUP [IF EXISTS] '<rg_name>'
```
##########
docs/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-GROUP.md:
##########
@@ -24,35 +24,38 @@ specific language governing permissions and limitations
under the License.
-->
-
-
-
-
-
## Description
This statement is used to create a workload group. Workload groups enable the
isolation of cpu resources and memory resources on a single be.
-grammar:
+## Syntax
```sql
CREATE WORKLOAD GROUP [IF NOT EXISTS] "rg_name"
PROPERTIES (
- property_list
+ "<key>"="<value>",
+ ...
);
```
-illustrate:
+## Required Parameters
+
+1.`<cpu_share>`
Review Comment:
语法中不存在`<cpu_share>`。参数中需要介绍语法中存在的元素 `<key>` 和 `<value>`。属性的kv可以这样搞。
1. 在语法中使用 `<property>`。
2. 在参数章节介绍 `<property>` 的格式是 `<key> = <value>`。 其中 key
的选值范围用表格来呈现，包括：名字，说明，可选 三列。在说明中写清楚 key 的作用和 value 如何填写
##########
docs/sql-manual/sql-statements/cluster-management/compute-management/DROP-RESOURCE.md:
##########
@@ -28,24 +28,21 @@ under the License.
## Description
This statement is used to delete an existing resource. Only the root or admin
user can delete resources.
-grammar:
+
+## Syntax
```sql
DROP RESOURCE 'resource_name'
Review Comment:
```suggestion
DROP RESOURCE '<resource_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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
