Hisoka-X commented on code in PR #3218:
URL: 
https://github.com/apache/incubator-seatunnel/pull/3218#discussion_r1008780471


##########
seatunnel-connectors-v2/README.md:
##########
@@ -22,13 +31,31 @@ configuration files used in example are saved in the 
"resources/examples" folder
 own connectors, you need to follow the steps below.
 
 1. Add the groupId, artifactId and version of the connector to be tested to
-   seatunnel-examples/seatunnel-flink-connector-v2-example/pom.xml(or add it to
-   seatunnel-examples/seatunnel-spark-connector-v2-example/pom.xml when you 
want to runs it in Spark engine) as a
+   `seatunnel-examples/seatunnel-flink-connector-v2-example/pom.xml`(or add it 
to
+   `seatunnel-examples/seatunnel-spark-connector-v2-example/pom.xml` when you 
want to runs it in Spark engine) as a
    dependency.
 2. Find the dependency in your connector pom file which scope is test or 
provided and then add them to
    seatunnel-examples/seatunnel-flink-connector-v2-example/pom.xml(or add it to
    seatunnel-examples/seatunnel-spark-connector-v2-example/pom.xml) file and 
modify the scope to compile.
-3. Refer to the SeaTunnelApiExample class to develop your sample code.
+3. Add the task configuration file under resources/examples.
+4. Configure the file in the `SeaTunnelApiExample` main method.
+5. Just run the main method.
+
+### **Create new seatunnel v2 connector**
+
+1.Create a new module under the `seatunnel-connectors-v2` directory and name 
it connector - {connector name}.
+
+2.The pom file can refer to the pom file of the existing connector, and add 
the current sub model to the pom file of the parent model
+
+3.Create two packages corresponding to source and sink
+
+​    package org.apache.seatunnel.connectors.seatunnel.{connector name}}.source
+
+​    package org.apache.seatunnel.connectors.seatunnel.{connector name}}.sink
+
+4.add connector to plugin-mapping file.

Review Comment:
   ```suggestion
   4.add connector info to plugin-mapping.properties file in seatunnel root 
path.
   ```



##########
seatunnel-connectors-v2/README.md:
##########
@@ -22,13 +31,31 @@ configuration files used in example are saved in the 
"resources/examples" folder
 own connectors, you need to follow the steps below.
 
 1. Add the groupId, artifactId and version of the connector to be tested to
-   seatunnel-examples/seatunnel-flink-connector-v2-example/pom.xml(or add it to
-   seatunnel-examples/seatunnel-spark-connector-v2-example/pom.xml when you 
want to runs it in Spark engine) as a
+   `seatunnel-examples/seatunnel-flink-connector-v2-example/pom.xml`(or add it 
to
+   `seatunnel-examples/seatunnel-spark-connector-v2-example/pom.xml` when you 
want to runs it in Spark engine) as a
    dependency.
 2. Find the dependency in your connector pom file which scope is test or 
provided and then add them to
    seatunnel-examples/seatunnel-flink-connector-v2-example/pom.xml(or add it to
    seatunnel-examples/seatunnel-spark-connector-v2-example/pom.xml) file and 
modify the scope to compile.
-3. Refer to the SeaTunnelApiExample class to develop your sample code.
+3. Add the task configuration file under resources/examples.
+4. Configure the file in the `SeaTunnelApiExample` main method.
+5. Just run the main method.
+
+### **Create new seatunnel v2 connector**
+
+1.Create a new module under the `seatunnel-connectors-v2` directory and name 
it connector - {connector name}.
+
+2.The pom file can refer to the pom file of the existing connector, and add 
the current sub model to the pom file of the parent model
+
+3.Create two packages corresponding to source and sink
+
+​    package org.apache.seatunnel.connectors.seatunnel.{connector name}}.source
+
+​    package org.apache.seatunnel.connectors.seatunnel.{connector name}}.sink
+
+4.add connector to plugin-mapping file.
+
+5.add connector to seatunnel-dist/pom.xml.

Review Comment:
   ```suggestion
   5.add connector dependency to seatunnel-dist/pom.xml, so the connector jar 
can be find in binary package .
   ```



-- 
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]

Reply via email to