search

GoogleCloudPlatform / pubsub

This repository contains open-source projects managed by the owners of Google Cloud Pub/Sub.
Apache License 2.0
246 stars 146 forks source link

Add initial documentation for Flink connector #359

Closed matt-kwong closed 8 months ago

matt-kwong commented 8 months ago

This PR documents how PubSubSink works in flink-connector/docs/content/docs/connectors/datastream/pubsub.md, loosely following the documentation structure used by similar Flink connectors. Feel free to suggest changes to the structure.

matt-kwong commented 8 months ago

maybe out of scope for this PR but do we have an example pipeline we can add here?

I added an example pipeline under flink-connector/flink-examples-gcp-pubsub/. I haven't referenced it in the docs, following the precedence of other connectors' docs.

clmccart commented 8 months ago

maybe out of scope for this PR but do we have an example pipeline we can add here?

I added an example pipeline under flink-connector/flink-examples-gcp-pubsub/. I haven't referenced it in the docs, following the precedence of other connectors' docs.

let's reference it. I think it'd be helpful to have here (no sense hiding it)

matt-kwong commented 8 months ago

let's reference it. I think it'd be helpful to have here (no sense hiding it)

Added.

I also added documentation for the sink and integration testing. The remaining TODO will be addressed in a future PR.