Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Doc] Update Pulsar Connector Guide #5015

Closed
Anonymitaet opened this issue Aug 22, 2019 · 4 comments · Fixed by #5168, #5173, #5183, #5184 or #5198
Closed

[Doc] Update Pulsar Connector Guide #5015

Anonymitaet opened this issue Aug 22, 2019 · 4 comments · Fixed by #5168, #5173, #5183, #5184 or #5198
Assignees
@Anonymitaet
Labels
area/connector doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Milestone
2.5.0

Comments

@Anonymitaet
Copy link
Member

Anonymitaet commented Aug 22, 2019 •
edited
Loading

Currently, the Pulsar connector guide is not clear, accurate and complete.
Plan to improve it overall.
@sijie sijie added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. area/connector component/website labels Aug 22, 2019
@sijie sijie added this to the 2.5.0 milestone Aug 22, 2019
@Anonymitaet
Copy link
Member Author

Old Structure of Pulsar Connector Guide:

Pulsar IO old

@Anonymitaet
Copy link
Member Author

Anonymitaet commented Aug 23, 2019 •
edited
Loading

I plan to rewrite this guide, the Updated Structure of Pulsar Connector Guide is as below.

(Will add contents in the red box or highlighted in yellow)

Pulsar IO Updated

@Anonymitaet
Copy link
Member Author

Anonymitaet commented Aug 23, 2019 •
edited
Loading

I've created the following PRs to improve the doc overall:

Overview

Use

Built-in connector

Overall: #5015

Connectors come into two types:

Source connector

Source connector name Configuration Example
Kafka #5203 #5203

Sink connector

Sink connector name Configuration Example
Flume #5238
JDBC #5275
MongoDB #5289
RabbitMQ #5290
Redis #5291
Solr #5292

CDC connector

Debug

Connector Admin CLI

@Anonymitaet
Copy link
Member Author

Anonymitaet commented Aug 23, 2019 •
edited
Loading

@sijie @tuteng could you please help review the Updated Structure of Pulsar Connector Guide?

@Anonymitaet Anonymitaet mentioned this issue Aug 29, 2019
Merged
This was referenced Sep 10, 2019
Merged
Merged
Merged
sijie pushed a commit that referenced this issue Sep 11, 2019
@Anonymitaet @sijie
[Doc] Add Built-in Connector (#5168)
7ef1b31 
1. Currently, Pulsar has 12 source connectors and 14 sink connectors.
I've added the list and will add configuration and example for each (especially for the yellow-highlighted parts).

![image](https://user-images.githubusercontent.com/50226895/64601212-17b6a100-d3ef-11e9-9a96-8b3553746e14.png)

2. I've deleted the io-managing.md because the contents of it have been transferred [here](https://pulsar.apache.org/docs/en/next/io-use/).

3. Fix #5015
This was referenced Sep 12, 2019
Merged
Merged
sijie pushed a commit that referenced this issue Sep 15, 2019
@Anonymitaet @sijie
Move Connector Admin CLI to Connector Guide (#5184)
a43a933 
Fix #5015
This was referenced Sep 17, 2019
Merged
Merged
sijie pushed a commit that referenced this issue Sep 17, 2019
@Anonymitaet @sijie
[Doc] Update *CDC connector guide* (#5198)
94d6911 
Fix #5015 (comment)
sijie pushed a commit that referenced this issue Sep 17, 2019
@Anonymitaet @sijie
[Doc] Update *Overview of Connector* (#5183)
26df3e7 
Fix #5015
sijie pushed a commit that referenced this issue Sep 17, 2019
@Anonymitaet @sijie
[Doc] Update Canal source connector guide (#5173)
627e6f8 
1. I've updated this guide based on `CanalSourceConfig.java` and `canal-mysql-source-config.yaml`.

2. Fix #5015
This was referenced Sep 17, 2019
Merged
Merged
Merged
Merged
sijie pushed a commit that referenced this issue Sep 18, 2019
@Anonymitaet @sijie
[Doc] Add configuration of Flume source connector (#5199)
af1d0ea 
1. Currently, Pulsar does not have any explanations for Flume source and sink connectors. This PR adds configuration of Flume source connector.

2. Fix #5015.
@Anonymitaet Anonymitaet mentioned this issue Sep 19, 2019
Merged
This was referenced Sep 19, 2019
Merged
Merged
Merged
Merged
sijie pushed a commit that referenced this issue Sep 22, 2019
@Anonymitaet @sijie
[Doc] Add *Kafka sink connector guide* (#5210)
c728bd5 
Fix #5015
This was referenced Sep 23, 2019
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
@Anonymitaet Anonymitaet mentioned this issue Sep 30, 2019
Merged
sijie pushed a commit that referenced this issue Oct 2, 2019
@Anonymitaet @sijie
[Doc] Add *Solr sink connector guide* (#5292)
7bee3ed 
Fix #5015
sijie pushed a commit that referenced this issue Oct 2, 2019
@Anonymitaet @sijie
[Doc] Add *MongoDB sink connector guide* (#5289)
2ed17a6 
Fix #5015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Anonymitaet Anonymitaet

Labels
area/connector doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Milestone
2.5.0
2 participants
@sijie @Anonymitaet