nicusX commented on code in PR #25181: URL: https://github.com/apache/flink/pull/25181#discussion_r1713439768
########## 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. + +To preview any connector docs changes not yet merged follow these steps: + +1. (If necessary) Push the latest changes to the connector docs to the forked repo, in a branch Review Comment: That is exactly the point. The goal is enabling contributors to preview their changes while they are still in their personal fork, maybe even before raising a PR -- 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: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
