This is an automated email from the ASF dual-hosted git repository.
kirs pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-seatunnel.git
The following commit(s) were added to refs/heads/dev by this push:
new 2ca38ac4 [Doc] [Improve] Update contribute guide about plugin mapping.
(#1893)
2ca38ac4 is described below
commit 2ca38ac40b9a15c9f9ea7fb1734554413a3f468e
Author: TrickyZerg <[email protected]>
AuthorDate: Tue May 17 11:30:44 2022 +0800
[Doc] [Improve] Update contribute guide about plugin mapping. (#1893)
* update contribute-plugin.md about plugin mapping.
* update contribute-plugin.md about plugin mapping.
---
docs/en/contribution/contribute-plugin.md | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/docs/en/contribution/contribute-plugin.md
b/docs/en/contribution/contribute-plugin.md
index ae58cb74..f687291b 100644
--- a/docs/en/contribution/contribute-plugin.md
+++ b/docs/en/contribution/contribute-plugin.md
@@ -89,10 +89,9 @@ fully qualified class name of your implementation.
## Add plugin to the distribution
-You need to add your plugin to the `seatunnel-connectors-spark-dist`
module,then the plugin will in distribution.
+You need to add your plugin to the `seatunnel-connectors-spark-dist` module,
then the plugin will in distribution.
```xml
-
<dependency>
<groupId>org.apache.seatunnel</groupId>
<artifactId>seatunnel-connector-spark-hello</artifactId>
@@ -102,6 +101,12 @@ You need to add your plugin to the
`seatunnel-connectors-spark-dist` module,then
After you using `mvn package` to make a distribution, you can find the plugin
in your ${distribution}/connectors/spark.
+## Add information to plugin-mapping.properties file
+
+SeaTunnel use `plugin-mapping.properties` file to locate the name of the jar
package, the file is under module `seatunnel-connectors`, the key/value rule in
+properties is : `engineName.pluginType.pluginName=artifactId`. eg:
`spark.source.hello=seatunnel-connector-spark-hello`.
+So that SeaTunnel can find plugin jar according to user's config file.
+
# Contribute Flink Plugins
The steps to contribute a Flink plugin is similar to the steps to contribute a
Spark plugin. Different from Spark, you
