morrySnow commented on code in PR #1911:
URL: https://github.com/apache/doris-website/pull/1911#discussion_r1925291576
##########
docs/sql-manual/sql-statements/plugin/INSTALL-PLUGIN.md:
##########
@@ -25,55 +25,63 @@ under the License.
-->
-
## Description
-This statement is used to install a plugin.
+This statement is used to install a plug-in
-grammar:
+## Syntax
```sql
-INSTALL PLUGIN FROM [source] [PROPERTIES ("key"="value", ...)]
+INSTALL PLUGIN FROM source [PROPERTIES ("key"="value", ...)]
Review Comment:
```suggestion
INSTALL PLUGIN FROM <source> [PROPERTIES ("<key>"="<value>", ...)]
```
##########
docs/sql-manual/sql-statements/plugin/SHOW-PLUGINS.md:
##########
@@ -27,27 +27,34 @@ under the License.
## Description
-This statement is used to display installed plugins
+This statement is used to display installed plug-ins
-grammar:
+## Syntax
-```SQL
+```sql
SHOW PLUGINS
```
-This command will display all user-installed and system built-in plugins
+## Return Value
-## Example
+|Description|Version|JavaVersion|ClassName|SoName|Sources|Status|Properties|
+|-----------|-------|-----------|---------|------|-------|------|----------|
+|builtin audit loader, to load audit log to internal
table|2.1.0|1.8.31|org.apache.doris.plugin.audit.AuditLoader||Builtin|INSTALLED|{}|
+|builtin audit
logger|0.12.0|1.8.31|org.apache.doris.plugin.audit.AuditLogBuilder||Builtin|INSTALLED|{}|
+|builtin sql dialect
converter|2.1.0|1.8.31|org.apache.doris.plugin.dialect.HttpDialectConverterPlugin||Builtin|INSTALLED|{}|
-1. Show installed plugins:
+## Permission Control
- ```SQL
- SHOW PLUGINS;
- ```
+The user executing this SQL command must have at least the following
permissions:
-## Keywords
+| Permissions | Object | Notes |
+|:-----------|:-----|:--------------|
+| Admin_priv | The entire cluster | Requires administrative privileges for the
entire cluster |
- SHOW, PLUGINS
+## Example
-## Best Practice
+- Show installed plugins:
+ ```SQL
+ SHOW PLUGINS;
+ ```
Review Comment:
这个后面，要把`SHOW PLUGINS;` 的结果写出来
##########
docs/sql-manual/sql-statements/plugin/SHOW-PLUGINS.md:
##########
@@ -27,27 +27,34 @@ under the License.
## Description
-This statement is used to display installed plugins
+This statement is used to display installed plug-ins
-grammar:
+## Syntax
-```SQL
+```sql
SHOW PLUGINS
```
-This command will display all user-installed and system built-in plugins
+## Return Value
-## Example
+|Description|Version|JavaVersion|ClassName|SoName|Sources|Status|Properties|
+|-----------|-------|-----------|---------|------|-------|------|----------|
+|builtin audit loader, to load audit log to internal
table|2.1.0|1.8.31|org.apache.doris.plugin.audit.AuditLoader||Builtin|INSTALLED|{}|
+|builtin audit
logger|0.12.0|1.8.31|org.apache.doris.plugin.audit.AuditLogBuilder||Builtin|INSTALLED|{}|
+|builtin sql dialect
converter|2.1.0|1.8.31|org.apache.doris.plugin.dialect.HttpDialectConverterPlugin||Builtin|INSTALLED|{}|
Review Comment:
这里是要说明返回的结果，每一列的含义。而不是给一个返回值的示例
##########
docs/sql-manual/sql-statements/plugin/UNINSTALL-PLUGIN.md:
##########
@@ -29,27 +29,33 @@ under the License.
This statement is used to uninstall a plugin.
-grammar:
+## Syntax：
```sql
UNINSTALL PLUGIN plugin_name;
Review Comment:
```suggestion
UNINSTALL PLUGIN <plugin_name>;
```
##########
docs/sql-manual/sql-statements/plugin/UNINSTALL-PLUGIN.md:
##########
@@ -29,27 +29,33 @@ under the License.
This statement is used to uninstall a plugin.
-grammar:
+## Syntax：
```sql
UNINSTALL PLUGIN plugin_name;
```
- plugin_name can be viewed with the `SHOW PLUGINS;` command.
+## Required parameters
-Only non-builtin plugins can be uninstalled.
+- plugin_name
Review Comment:
类似的问题
##########
docs/sql-manual/sql-statements/plugin/INSTALL-PLUGIN.md:
##########
@@ -25,55 +25,63 @@ under the License.
-->
-
## Description
-This statement is used to install a plugin.
+This statement is used to install a plug-in
-grammar:
+## Syntax
```sql
-INSTALL PLUGIN FROM [source] [PROPERTIES ("key"="value", ...)]
+INSTALL PLUGIN FROM source [PROPERTIES ("key"="value", ...)]
```
-source supports three types:
+## Required parameters
+
+- source
+ The plugin path to be installed, supports three types：
+ 1. An absolute path to a zip file
+ 2. An absolute path to a plugin directory
+ 3. Points to a zip file download path with http or https protocol
+
+## Optional parameters
+
+- PROPERTIES
+ Used to specify properties or parameters when installing a plug-in
+
+## Permission Control
+
+The user executing this SQL command must have at least the following
permissions:
+
+| Permissions | Object | Notes |
+|:-----------|:-----|:--------------|
+| Admin_priv | The entire cluster | Requires administrative privileges for the
entire cluster |
Review Comment:
```suggestion
| ADMIN_PRIV | The entire cluster | Requires administrative privileges for
the entire cluster |
```
##########
docs/sql-manual/sql-statements/plugin/INSTALL-PLUGIN.md:
##########
@@ -25,55 +25,63 @@ under the License.
-->
-
## Description
-This statement is used to install a plugin.
+This statement is used to install a plug-in
-grammar:
+## Syntax
```sql
-INSTALL PLUGIN FROM [source] [PROPERTIES ("key"="value", ...)]
+INSTALL PLUGIN FROM source [PROPERTIES ("key"="value", ...)]
```
-source supports three types:
+## Required parameters
+
+- source
+ The plugin path to be installed, supports three types：
+ 1. An absolute path to a zip file
+ 2. An absolute path to a plugin directory
+ 3. Points to a zip file download path with http or https protocol
Review Comment:
1. 使用有序列表
2. 带上尖括号，使用 inline code
3. 加粗
4. 说明的地方使用引用
```suggestion
** 1. `<source>`**
> The plugin path to be installed, supports three types：
> 1. An absolute path to a zip file
> 2. An absolute path to a plugin directory
> 3. Points to a zip file download path with http or https protocol
```
--
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]
