morrySnow commented on code in PR #1823:
URL: https://github.com/apache/doris-website/pull/1823#discussion_r1919523242
##########
docs/sql-manual/sql-statements/Data-Definition-Statements/Alter/ALTER-RESOURCE.md:
##########
@@ -24,37 +25,38 @@ specific language governing permissions and limitations
under the License.
-->
-## ALTER-RESOURCE
-
-### Name
+## Description
-ALTER RESOURCE
+This statement is used to modify an existing resource. Only the root or admin
user can modify resources.
-### Description
+## Syntax
-This statement is used to modify an existing resource. Only the root or admin
user can modify resources.
-Syntax:
```sql
ALTER RESOURCE 'resource_name'
-PROPERTIES ("key"="value", ...);
+PROPERTIES (
+ "key"="value",
+ ...
+);
Review Comment:
需要增加参数章节，介绍 key 的可选值和含义，以及 value 的合法值和含义
##########
docs/sql-manual/sql-statements/Data-Definition-Statements/Alter/ALTER-WORKLOAD-GROUP.md:
##########
@@ -24,31 +24,26 @@ specific language governing permissions and limitations
under the License.
-->
-## ALTER-WORKLOAD-GROUP
-
-### Name
-
-ALTER WORKLOAD GROUP
-
-### Description
+## 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/Data-Definition-Statements/Create/CREATE-RESOURCE.md:
##########
@@ -24,32 +24,28 @@ specific language governing permissions and limitations
under the License.
-->
-## CREATE-RESOURCE
-
-### Name
-
-CREATE RESOURCE
-
-### Description
+## 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", ...);
Review Comment:
同上
##########
docs/sql-manual/sql-statements/Data-Definition-Statements/Create/CREATE-RESOURCE.md:
##########
@@ -24,32 +24,28 @@ specific language governing permissions and limitations
under the License.
-->
-## CREATE-RESOURCE
-
-### Name
-
-CREATE RESOURCE
-
-### Description
+## 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", ...);
```
-illustrate:
+## Required Parameters
+1. `<type>`
+The type of resource needs to be specified in PROPERTIES "type" =
"[spark|odbc_catalog|s3]", currently supports spark, odbc_catalog, s3.
-- The type of resource needs to be specified in PROPERTIES "type" =
"[spark|odbc_catalog|s3]", currently supports spark, odbc_catalog, s3.
-- PROPERTIES differs depending on the resource type, see the example for
details.
+2. `<properties>`
Review Comment:
语法中没有<properties>，需要和语法内的参数对齐
##########
docs/sql-manual/sql-statements/Show-Statements/SHOW-WORKLOAD-GROUPS.md:
##########
@@ -24,27 +24,21 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW-workload-GROUPS
-
-### Name
-
-SHOW workload GROUPS
-
-### Description
+## Description
This statement is used to display the resource groups for which the current
user has usage_priv privileges.
-grammar:
+## Syntax
```sql
SHOW WORKLOAD GROUPS [LIKE "pattern"];
Review Comment:
参数都需要尖括号 `"<pattern>"`
##########
docs/sql-manual/sql-statements/Data-Definition-Statements/Alter/ALTER-RESOURCE.md:
##########
@@ -24,37 +25,38 @@ specific language governing permissions and limitations
under the License.
-->
-## ALTER-RESOURCE
-
-### Name
+## Description
-ALTER RESOURCE
+This statement is used to modify an existing resource. Only the root or admin
user can modify resources.
-### Description
+## Syntax
-This statement is used to modify an existing resource. Only the root or admin
user can modify resources.
-Syntax:
```sql
ALTER RESOURCE 'resource_name'
-PROPERTIES ("key"="value", ...);
+PROPERTIES (
+ "key"="value",
Review Comment:
```suggestion
"<key>"="<value>",
```
##########
docs/sql-manual/sql-statements/Show-Statements/SHOW-RESOURCES.md:
##########
@@ -24,17 +24,11 @@ specific language governing permissions and limitations
under the License.
-->
-## SHOW-RESOURCES
-
-### Name
-
-SHOW RESOURCES
-
-### Description
+## Description
This statement is used to display resources that the user has permission to
use. Ordinary users can only display resources with permission, and root or
admin users will display all resources.
-grammar:
+## Syntax
Review Comment:
下面的语法是不是有点儿问题，比如
```
[RESOURCETYPE = ["SPARK"]]
```
为什么等号后面的 `"SPARK"` 是可选的？ 而且这里只能填 "SPARK"?
--
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]
