Update connector guide overall (apache#5296)

site2/docs/io-cdc-canal.md → site2/docs/io-canal-source.md

@@ -1,18 +1,16 @@
 ---
-id: io-cdc-canal
+id: io-canal-source
 title: Canal source connector
 sidebar_label: Canal source connector
 ---
 
 The Canal source connector pulls messages from MySQL to Pulsar topics.
 
-This guide explains how to congifure and use Canal source connector.
-
 ## Configuration
 
-The configuration of Canal source connector has the following parameters.
+The configuration of Canal source connector has the following properties.
 
-### Parameter
+### Property
 
 | Name | Required | Default | Description |
 |------|----------|---------|-------------|
@@ -51,13 +49,13 @@ Before using the Canal connector, you can create a configuration file through on
     ```yaml
     configs:
         zkServers: "127.0.0.1:2181"
-        batchSize: "5120"
+        batchSize: 5120
         destination: "example"
         username: ""
         password: ""
         cluster: false
         singleHostname: "127.0.0.1"
-        singlePort: "11111"
+        singlePort: 11111
     ```
 
 ## Usage

site2/docs/io-cassandra-sink.md

@@ -20,7 +20,34 @@ The configuration of the Cassandra sink connector has the following properties.
 | `columnFamily` | String|true| " " (empty string)| The Cassandra column family name.<br><br>**Note: `columnFamily` should be created prior to a Cassandra sink.**|
 | `columnName` | String|true| " " (empty string) | The column name of the Cassandra column family.<br><br> The column is used for storing Pulsar message values. |
 
+### Example
+
+Before using the Cassandra sink connector, you need to create a configuration file through one of the following methods.
+
+* JSON
+
+    ```json
+    {
+        "roots": "localhost:9042",
+        "keyspace": "pulsar_test_keyspace",
+        "columnFamily": "pulsar_test_table",
+        "keyname": "key",
+        "columnName": "col"
+    }
+    ```
+
+* YAML
+
+    ```
+    configs:
+        roots: "localhost:9042"
+        keyspace: "pulsar_test_keyspace"
+        columnFamily: "pulsar_test_table"
+        keyname: "key"
+        columnName: "col"
+    ```
+
 
 ## Usage
 
-For more information about **How to connect Pulsar with Apache Cassandra**, see [here](io-quickstart.md#connect-pulsar-to-apache-cassandra).
+For more information about **how to connect Pulsar with Cassandra**, see [here](io-quickstart.md#connect-pulsar-to-apache-cassandra).

site2/docs/io-cdc-debezium.md

@@ -1,16 +1,15 @@
 ---
-id: io-cdc-debezium
-title: Debezium Connector
-sidebar_label: Debezium Connector
+id: io-debezium-source
+title: Debezium source connector
+sidebar_label: Debezium source connector
 ---
 
-The Debezium source connector pulls messages from MySQL or PostgreSQL to Pulsar topics.
-
-This guide explains how to congifure and use Debezium source connector.
+The Debezium source connector pulls messages from MySQL or PostgreSQL 
+and persists the messages to Pulsar topics.
 
 ## Configuration 
 
-The configuration of Debezium source connector has the following parameters.
+The configuration of Debezium source connector has the following properties.
 
 | Name | Required | Default | Description |
 |------|----------|---------|-------------|

site2/docs/io-cdc.md

@@ -12,10 +12,10 @@ Currently, Pulsar has the following CDC connectors.
 
 Name|Java Class
 |---|---
-[Canal source connector](io-cdc-canal.md)|[`org.apache.pulsar.io.canal.CanalStringSource.java`](https://github.com/apache/pulsar/blob/master/pulsar-io/canal/src/main/java/org/apache/pulsar/io/canal/CanalStringSource.java)
-[Debezium source connector](io-cdc-debezium.md)|<li>[`org.apache.pulsar.io.debezium.DebeziumSource.java`](https://github.com/apache/pulsar/blob/master/pulsar-io/debezium/core/src/main/java/org/apache/pulsar/io/debezium/DebeziumSource.java)<br/><li>[`org.apache.pulsar.io.debezium.mysql.DebeziumMysqlSource.java`](https://github.com/apache/pulsar/blob/master/pulsar-io/debezium/mysql/src/main/java/org/apache/pulsar/io/debezium/mysql/DebeziumMysqlSource.java)<br/><li>[`org.apache.pulsar.io.debezium.postgres.DebeziumPostgresSource.java`](https://github.com/apache/pulsar/blob/master/pulsar-io/debezium/postgres/src/main/java/org/apache/pulsar/io/debezium/postgres/DebeziumPostgresSource.java)
+[Canal source connector](io-cdc-canal.md)|[org.apache.pulsar.io.canal.CanalStringSource.java](https://github.com/apache/pulsar/blob/master/pulsar-io/canal/src/main/java/org/apache/pulsar/io/canal/CanalStringSource.java)
+[Debezium source connector](io-cdc-debezium.md)|<li>[org.apache.pulsar.io.debezium.DebeziumSource.java](https://github.com/apache/pulsar/blob/master/pulsar-io/debezium/core/src/main/java/org/apache/pulsar/io/debezium/DebeziumSource.java)<br/><li>[org.apache.pulsar.io.debezium.mysql.DebeziumMysqlSource.java](https://github.com/apache/pulsar/blob/master/pulsar-io/debezium/mysql/src/main/java/org/apache/pulsar/io/debezium/mysql/DebeziumMysqlSource.java)<br/><li>[org.apache.pulsar.io.debezium.postgres.DebeziumPostgresSource.java](https://github.com/apache/pulsar/blob/master/pulsar-io/debezium/postgres/src/main/java/org/apache/pulsar/io/debezium/postgres/DebeziumPostgresSource.java)
 
-For more information about Canal and Debezium, see the following information.
+For more information about Canal and Debezium, see the information below.
 
 Subject | Reference
 |---|---

site2/docs/reference-connector-admin.md → site2/docs/io-cli.md

@@ -1,7 +1,7 @@
 ---
-id: reference-connector-admin
+id: io-cli
 title: Connector Admin CLI
-sidebar_label: Connector Admin CLI
+sidebar_label: CLI
 ---
 
 The `pulsar-admin` tool helps you manage Pulsar connectors.

site2/docs/io-connectors.md

@@ -12,60 +12,41 @@ Using any of these connectors is as easy as writing a simple connector and runni
 
 Pulsar has various source connectors, which are sorted alphabetically as below.
 
-- [Canal source connector](io-cdc-canal.md)
+Name|Java class
+|---|---
+[Canal](io-canal-source.md) |[org.apache.pulsar.io.canal.CanalStringSource.java](https://github.com/apache/pulsar/blob/master/pulsar-io/canal/src/main/java/org/apache/pulsar/io/canal/CanalStringSource.java)
+[Debezium MySQL](io-debezium-source.md)|[org.apache.pulsar.io.debezium.mysql.DebeziumMysqlSource.java](https://github.com/apache/pulsar/blob/master/pulsar-io/debezium/mysql/src/main/java/org/apache/pulsar/io/debezium/mysql/DebeziumMysqlSource.java)
+[Debezium PostgreSQL](io-postgresql-debezium.md)|[org.apache.pulsar.io.debezium.postgres.DebeziumPostgresSource.java](https://github.com/apache/pulsar/blob/master/pulsar-io/debezium/postgres/src/main/java/org/apache/pulsar/io/debezium/postgres/DebeziumPostgresSource.java)
+[File](io-file-source.md)|[org.apache.pulsar.io.file.FileSource.java](https://github.com/apache/pulsar/blob/master/pulsar-io/file/src/main/java/org/apache/pulsar/io/file/FileSource.java)
+[Flume](io-flume-source.md)|[org.apache.pulsar.io.flume.FlumeConnector.java](https://github.com/apache/pulsar/blob/master/pulsar-io/flume/src/main/java/org/apache/pulsar/io/flume/FlumeConnector.java)
+[Twitter firehose](io-twitter-source.md)|[org.apache.pulsar.io.twitter.TwitterFireHose.java](https://github.com/apache/pulsar/blob/master/pulsar-io/twitter/src/main/java/org/apache/pulsar/io/twitter/TwitterFireHose.java)
+[Kafka](io-kafka-source.md)|[org.apache.pulsar.io.kafka.KafkaAbstractSource.java](https://github.com/apache/pulsar/blob/master/pulsar-io/kafka/src/main/java/org/apache/pulsar/io/kafka/KafkaAbstractSource.java)
+[Kinesis](io-kinesis-source.md)|[org.apache.pulsar.io.kinesis.KinesisSource.java](https://github.com/apache/pulsar/blob/master/pulsar-io/kinesis/src/main/java/org/apache/pulsar/io/kinesis/KinesisSource.java)
+[Netty](io-netty-source.md)|[org.apache.pulsar.io.netty.NettySource.java](https://github.com/apache/pulsar/blob/master/pulsar-io/netty/src/main/java/org/apache/pulsar/io/netty/NettySource.java)
+[RabbitMQ](io-rabbitmq-source.md)|[org.apache.pulsar.io.rabbitmq.RabbitMQSource.java](https://github.com/apache/pulsar/blob/master/pulsar-io/rabbitmq/src/main/java/org/apache/pulsar/io/rabbitmq/RabbitMQSource.java)
 
-- [Data-generator source connector](io-data-generator.md)
-
-- [Debezium MySQL source connector](io-cdc-debezium.md)
-
-- [Debezium PostgreSQL source Connector](io-postgresql-debezium.md)
-
-- [File source connector](io-file-source.md)
-
-- [Flume source connector](io-flume-source.md)
-
-- [Twitter firehose source connector](io-twitter-source.md)
-
-- [Kafka source connector](io-kafka-source.md)
-
-- [Kafka-connect-adaptor source connector](io-kafka-connect.md)
-
-- [Kinesis source connector](io-kinesis-source.md)
-
-- [Netty source connector](io-netty-source.md)
-
-- [RabbitMQ source connector](io-rabbitmq-source.md)
 
 ## Sink connector
 
 Pulsar has various sink connectors, which are sorted alphabetically as below.
 
-- [Aerospike sink connector](io-aerospike-sink.md)
-
-- [Cassandra sink connector](io-cassandra-sink.md)
-
-- [ElasticSearch sink connector](io-elasticsearch-sink.md)
-
-- [Flume sink connector](io-flume-sink.md)
-
-- [HBase sink connector](io-hbase.md)
-
-- [HDFS2 sink connector](io-hdfs2-sink.md)
-
-- [HDFS3 sink connector](io-hdfs3-sink.md)
-
-- [InfluxDB sink connector](io-influxdb-sink.md)
-
-- [JDBC sink connector](io-jdbc-sink.md)
-
-- [Kafka sink connector](io-kafka-sink.md)
-
-- [Kinesis sink connector](io-kinesis-sink.md)
-
-- [MongoDB sink connector](io-mongo-sink.md)
+Name|Java class
+|---|---
+[Aerospike](io-aerospike-sink.md)|[org.apache.pulsar.io.aerospike.AerospikeStringSink.java](https://github.com/apache/pulsar/blob/master/pulsar-io/aerospike/src/main/java/org/apache/pulsar/io/aerospike/AerospikeStringSink.java)
+[Cassandra](io-cassandra-sink.md)|[org.apache.pulsar.io.cassandra.CassandraStringSink.java](https://github.com/apache/pulsar/blob/master/pulsar-io/cassandra/src/main/java/org/apache/pulsar/io/cassandra/CassandraStringSink.java)
+[ElasticSearch](io-elasticsearch-sink.md)|[org.apache.pulsar.io.elasticsearch.ElasticSearchSink.java](https://github.com/apache/pulsar/blob/master/pulsar-io/elastic-search/src/main/java/org/apache/pulsar/io/elasticsearch/ElasticSearchSink.java)
+[Flume](io-flume-sink.md)|[org.apache.pulsar.io.flume.sink.StringSink.java](https://github.com/apache/pulsar/blob/master/pulsar-io/flume/src/main/java/org/apache/pulsar/io/flume/sink/StringSink.java)
+[HBase](io-hbase.md)|[org.apache.pulsar.io.hbase.HbaseAbstractConfig.java](https://github.com/apache/pulsar/blob/master/pulsar-io/hbase/src/main/java/org/apache/pulsar/io/hbase/HbaseAbstractConfig.java)
+[HDFS2](io-hdfs2.md)|[org.apache.pulsar.io.hdfs2.AbstractHdfsConnector.java](https://github.com/apache/pulsar/blob/master/pulsar-io/hdfs2/src/main/java/org/apache/pulsar/io/hdfs2/AbstractHdfsConnector.java)
+[HDFS3](io-hdfs3.md)|[org.apache.pulsar.io.hdfs3.AbstractHdfsConnector.java](https://github.com/apache/pulsar/blob/master/pulsar-io/hdfs3/src/main/java/org/apache/pulsar/io/hdfs3/AbstractHdfsConnector.java)
+[InfluxDB](io-influxdb-sink.md)|[org.apache.pulsar.io.influxdb.InfluxDBAbstractSink.java](https://github.com/apache/pulsar/blob/master/pulsar-io/influxdb/src/main/java/org/apache/pulsar/io/influxdb/InfluxDBAbstractSink.java)
+[JDBC](io-jdbc-sink.md)|[org.apache.pulsar.io.jdbc.JdbcAbstractSink.java](https://github.com/apache/pulsar/blob/master/pulsar-io/jdbc/src/main/java/org/apache/pulsar/io/jdbc/JdbcAbstractSink.java)
+[Kafka](io-kafka-sink.md)|[org.apache.pulsar.io.kafka.KafkaAbstractSink.java](https://github.com/apache/pulsar/blob/master/pulsar-io/kafka/src/main/java/org/apache/pulsar/io/kafka/KafkaAbstractSink.java)
+[Kinesis](io-kinesis-sink.md)|[org.apache.pulsar.io.kinesis.KinesisSink.java](https://github.com/apache/pulsar/blob/master/pulsar-io/kinesis/src/main/java/org/apache/pulsar/io/kinesis/KinesisSink.java)
+[MongoDB](io-mongo.md)|[org.apache.pulsar.io.mongodb.MongoSink.java](https://github.com/apache/pulsar/blob/master/pulsar-io/mongo/src/main/java/org/apache/pulsar/io/mongodb/MongoSink.java)
+[RabbitMQ](io-rabbitmq-sink.md)|[org.apache.pulsar.io.rabbitmq.RabbitMQSink.java](https://github.com/apache/pulsar/blob/master/pulsar-io/rabbitmq/src/main/java/org/apache/pulsar/io/rabbitmq/RabbitMQSink.java)
+[Redis](io-redis.md)|[org.apache.pulsar.io.redis.RedisAbstractConfig.java](https://github.com/apache/pulsar/blob/master/pulsar-io/redis/src/main/java/org/apache/pulsar/io/redis/RedisAbstractConfig.java)
+[Solr](io-solr.md)|[org.apache.pulsar.io.solr.SolrSinkConfig.java](https://github.com/apache/pulsar/blob/master/pulsar-io/solr/src/main/java/org/apache/pulsar/io/solr/SolrSinkConfig.java)
 
-- [RabbitMQ sink connector](io-rabbitmq-sink.md)
 
-- [Redis sink connector](io-redis-sink.md)
 
-- [Solr sink connector](io-solr-sink.md)