[ https://issues.apache.org/jira/browse/FLINK-6660?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16020739#comment-16020739 ]
ASF GitHub Bot commented on FLINK-6660: --------------------------------------- Github user tzulitai commented on a diff in the pull request: https://github.com/apache/flink/pull/3964#discussion_r117914005 --- Diff: docs/dev/connectors/index.md --- @@ -25,22 +25,54 @@ specific language governing permissions and limitations under the License. --> -Connectors provide code for interfacing with various third-party systems. +* toc +{:toc} -Currently these systems are supported: (Please select the respective documentation page from the navigation on the left.) +## Predefined Sources and Sinks - * [Apache Kafka](https://kafka.apache.org/) (sink/source) - * [Elasticsearch](https://elastic.co/) (sink) - * [Hadoop FileSystem](http://hadoop.apache.org) (sink) - * [RabbitMQ](http://www.rabbitmq.com/) (sink/source) - * [Amazon Kinesis Streams](http://aws.amazon.com/kinesis/streams/) (sink/source) - * [Twitter Streaming API](https://dev.twitter.com/docs/streaming-apis) (source) - * [Apache NiFi](https://nifi.apache.org) (sink/source) - * [Apache Cassandra](https://cassandra.apache.org/) (sink) +A few basic data sources and sinks are built into Flink and are always available. +The [predefined data sources]({{ site.baseurll }}/dev/datastream_api.html#data-sources) include reading from files, directories, and sockets, and +ingesting data from collections and iterators. +The [predefined data sinks]({{ site.baseurl }}/dev/datastream_api.html#data-sinks) support writing to files, to stdout and stderr, and to sockets. +## Bundled Connectors +Connectors provide code for interfacing with various third-party systems. Currently these systems are supported: -To run an application using one of these connectors, additional third party -components are usually required to be installed and launched, e.g. the servers -for the message queues. Further instructions for these can be found in the -corresponding subsections. + * [Apache Kafka](kafka.html) (sink/source) + * [Apache Cassandra](cassandra.html) (sink) + * [Amazon Kinesis Streams](kinesis.html) (sink/source) + * [Elasticsearch](elasticsearch.html) (sink) + * [Hadoop FileSystem](filesystem_sink.html) (sink) + * [RabbitMQ](rabbitmq.html) (sink/source) + * [Apache NiFi](nifi.html) (sink/source) + * [Twitter Streaming API](twitter.html) (source) + +Keep in mind that to use one of these connectors in an application, additional third party +components are usually required, e.g. servers for the data stores or message queues. +Note also that while the streaming connectors listed in this section are part of the +Flink project and are included in source releases, they are not included in the binary distributions. +Further instructions can be found in the corresponding subsections. + +## Related Topics --- End diff -- I somehow find the related topics listed here a bit out-of-place. I can understand the intention, but was also wondering whether a separate "Common usage patterns" page is a better placement for these topics? > expand the streaming connectors overview page > ---------------------------------------------- > > Key: FLINK-6660 > URL: https://issues.apache.org/jira/browse/FLINK-6660 > Project: Flink > Issue Type: Improvement > Components: Documentation, Streaming Connectors > Affects Versions: 1.3.0, 1.4.0 > Reporter: David Anderson > Assignee: David Anderson > > The overview page for streaming connectors is too lean -- it should provide > more context and also guide the reader toward related topics. > Note that FLINK-6038 will add links to the Bahir connectors. -- This message was sent by Atlassian JIRA (v6.3.15#6346)