featzhang commented on PR #30: URL: https://github.com/apache/flink-connector-http/pull/30#issuecomment-4052474788
> I have looked at the Kafka connector and - we follow the style of its readme. The Getindata readme was effectively all of the docs. Now the docs are in a folder that will be picked up and knitted into the flink docs when we release. If you can find a nice place in the docs for this - then please change to add there. Thank you for the guidance! That makes total sense — the README should stay lightweight (following the Kafka connector style), and the richer usage content belongs in docs/ where it gets knitted into the official Flink documentation on release. I've taken a look at the existing docs/content/docs/connectors/datastream/http.md , which already contains the DataStream API usage. I'll move the Quick Start examples (including the SQL/Table API usage) into an appropriate section in the docs rather than keeping them in the README. I'll update the README to just include a pointer to the docs, and add the Quick Start content into docs/content/docs/connectors/ — likely under a new section or alongside the existing http.md . Will push an update shortly. -- 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]
