nicusX commented on code in PR #25181: URL: https://github.com/apache/flink/pull/25181#discussion_r1713438446
########## docs/README.md: ########## @@ -62,6 +62,23 @@ externally hosted documentation. The reference will look like `integrate_connect Replace <connector_name> with the name of your connector, e.g., `elasticsearch` for `flink-connector-elasticsearch`. +### Include external documentation hosted on forks + +The configuration above works for connectors already merged in `apache/flinl-connector-<connector-name>` repos. +When contributing to a Flink's connector, the documentation is hosted in a fork of one of these repos. Review Comment: I probably need to rephrase. The key is that the script generating docs only pulls branch/tags from the official repos. If you are contributing to a connector and you want to preview your changes before they are merged, you must include what is in your fork -- 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]
