You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by GitBox <gi...@apache.org> on 2021/10/28 10:32:57 UTC
[GitHub] [dolphinscheduler-website] zhongjiajie commented on a change in pull request #477: add plugin version description
zhongjiajie commented on a change in pull request #477:
URL: https://github.com/apache/dolphinscheduler-website/pull/477#discussion_r738256265
##########
File path: development/en-us/backend/spi/alert.md
##########
@@ -96,8 +96,14 @@ The specific design of alert_spi can be found in issue: [Alert Plugin Design](ht
In fact, it's very easy to implement a plugin by yourself, you only need to care about the plugin extension interface. In Alert you only need to care about the AlertChannelFactory and AlertChannel. We would recommend that you follow the design specifications of other built-in plugins so that when your idea is good enough, you can donate it to the community without having to change it too much.
-When you have finished developing the relevant code, configure the relevant plug-ins in alert.properties (or just configure a plug-in directory and it will load all the plug-ins in that directory).
+When you complete the development of the relevant code, you need to execute `mvn -U install -Dmaven.test.skip=true` to install the plug-in and generate the plug-in jar of the registry. The directory is: dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert (the version number will change with the main version number)
+Note: ${VERSION} needs to be manually modified according to the current version.
+
Review comment:
```suggestion
```
##########
File path: development/en-us/backend/spi/alert.md
##########
@@ -96,8 +96,14 @@ The specific design of alert_spi can be found in issue: [Alert Plugin Design](ht
In fact, it's very easy to implement a plugin by yourself, you only need to care about the plugin extension interface. In Alert you only need to care about the AlertChannelFactory and AlertChannel. We would recommend that you follow the design specifications of other built-in plugins so that when your idea is good enough, you can donate it to the community without having to change it too much.
-When you have finished developing the relevant code, configure the relevant plug-ins in alert.properties (or just configure a plug-in directory and it will load all the plug-ins in that directory).
+When you complete the development of the relevant code, you need to execute `mvn -U install -Dmaven.test.skip=true` to install the plug-in and generate the plug-in jar of the registry. The directory is: dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert (the version number will change with the main version number)
+Note: ${VERSION} needs to be manually modified according to the current version.
+
+alert.properties configuration
+```
+alert.plugin.dir=../../../../dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert
Review comment:
I think we should directly add some comment on the configure
```suggestion
# Note: You need to modify ${VERSION} according to the current version by yourself.
alert.plugin.dir=../../../../dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert
```
##########
File path: development/zh-cn/backend/spi/alert.md
##########
@@ -92,9 +92,13 @@ alert_spi 具体设计可见 issue：[Alert Plugin Design](https://github.com/ap
事实上，自我实现一款插件及其简单，仅仅关心插件扩展接口即可，Alert 中你只需要关心 AlertChannelFactory 以及 AlertChannel。我们更建议你按照其他内置插件的设计规范来去开发，这样当你的idea足够好的时候，你无需做过多更改即可捐献给社区。
-当你完成相关代码开发的时候在 alert.properties 配置相关插件（或者仅仅配置一个插件目录，他会加载该目录下的所有插件）。
-
+注意：${VERSION} 需要根据当前版本手动修改。
+当你完成相关代码开发的时候, 你需要执行 `mvn -U install -Dmaven.test.skip=true` 安装插件，生成注册中心的插件 jar。目录是：dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert（版本号会跟随主版本号变更）
+alert.properties 配置
+```
+alert.plugin.dir=../../../../dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert
Review comment:
```suggestion
# 注意：${VERSION} 需要根据当前版本手动修改。
alert.plugin.dir=../../../../dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert
```
##########
File path: development/zh-cn/backend/spi/alert.md
##########
@@ -92,9 +92,13 @@ alert_spi 具体设计可见 issue：[Alert Plugin Design](https://github.com/ap
事实上，自我实现一款插件及其简单，仅仅关心插件扩展接口即可，Alert 中你只需要关心 AlertChannelFactory 以及 AlertChannel。我们更建议你按照其他内置插件的设计规范来去开发，这样当你的idea足够好的时候，你无需做过多更改即可捐献给社区。
-当你完成相关代码开发的时候在 alert.properties 配置相关插件（或者仅仅配置一个插件目录，他会加载该目录下的所有插件）。
-
+注意：${VERSION} 需要根据当前版本手动修改。
Review comment:
```suggestion
```
##########
File path: development/en-us/backend/spi/alert.md
##########
@@ -96,8 +96,14 @@ The specific design of alert_spi can be found in issue: [Alert Plugin Design](ht
In fact, it's very easy to implement a plugin by yourself, you only need to care about the plugin extension interface. In Alert you only need to care about the AlertChannelFactory and AlertChannel. We would recommend that you follow the design specifications of other built-in plugins so that when your idea is good enough, you can donate it to the community without having to change it too much.
-When you have finished developing the relevant code, configure the relevant plug-ins in alert.properties (or just configure a plug-in directory and it will load all the plug-ins in that directory).
+When you complete the development of the relevant code, you need to execute `mvn -U install -Dmaven.test.skip=true` to install the plug-in and generate the plug-in jar of the registry. The directory is: dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert (the version number will change with the main version number)
Review comment:
```suggestion
When you complete the development of the relevant code, you need to execute `mvn -U install -Dmaven.test.skip=true` to install the plug-in and generate the plug-in jar of the alert. The directory is: dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert (the version number will change with the main version number)
```
--
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-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org