dannycranmer commented on code in PR #25181: URL: https://github.com/apache/flink/pull/25181#discussion_r1713337144
########## 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 am not sure what this means. Do you mean the docs reside alongside the connector code in a separate repo? They are not _hosted_ in a fork, they are pulled in at _build_ time ########## 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. Review Comment: ```suggestion The configuration above works for connectors already merged in `apache/flink-connector-<connector-name>` repos. ``` ########## 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 + +2. In the Flink repository, edit the `docs/setup_docs.sh` file and add a reference to your forked repo. The reference will look like `integrate_connector_fork_docs <fork_owner> <connector_name> <branch_or_tag>`. If you are working on an existing connector, replace the original `integrate_connector_docs <connector_name>...` reference of the same connector with the reference to your fork. If you are working on a new connector not yet released, append the new reference after all other existing connectors. Review Comment: A more specific, full example would be helpful here. "If your fork is x and you are contributing to y then the configuration should look like z" ########## 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: > docs to the forked repo It is not clear which fork this is, but now I guess you are talking about the contributors personal fork? Can you make this clearer ########## 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 + +2. In the Flink repository, edit the `docs/setup_docs.sh` file and add a reference to your forked repo. The reference will look like `integrate_connector_fork_docs <fork_owner> <connector_name> <branch_or_tag>`. If you are working on an existing connector, replace the original `integrate_connector_docs <connector_name>...` reference of the same connector with the reference to your fork. If you are working on a new connector not yet released, append the new reference after all other existing connectors. Review Comment: ```suggestion 2. In your local clone of the Flink repository, edit the `docs/setup_docs.sh` file and add a reference to your forked repo. The reference will look like `integrate_connector_fork_docs <fork_owner> <connector_name> <branch_or_tag>`. If you are working on an existing connector, replace the original `integrate_connector_docs <connector_name>...` reference of the same connector with the reference to your fork. If you are working on a new connector not yet released, append the new reference after all other existing connectors. ``` -- 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
