LadyForest commented on code in PR #24271:
URL: https://github.com/apache/flink/pull/24271#discussion_r1501360520
##########
docs/setup_docs.sh:
##########
@@ -36,24 +36,33 @@ function integrate_connector_docs {
}
+SKIP_INTEGRATE_CONNECTOR_DOCS=false
+for arg in "$@"; do
+ if [ "$arg" == "--skip-integrate-connector-docs" ]; then
+ SKIP_INTEGRATE_CONNECTOR_DOCS=true
+ break
+ fi
+done
+
# Integrate the connector documentation
+if [ "$SKIP_INTEGRATE_CONNECTOR_DOCS" = false ]; then
Review Comment:
I think we need to check whether the directory exists or not as well.
I `rm -rf` the connectors directory and try `./build_docs.sh
--skip-integrate-connector-docs`. Unfortunately, the error is thrown.
##########
docs/README.md:
##########
@@ -37,6 +37,14 @@ Then build the docs from source:
$ ./build_docs.sh
```
+The shell `./build_docs.sh` will integrate external connector docs,
referencing `setup_docs.sh#integrate_connector_docs`.
+This process involves cloning the repo of some external connectors, which can
be time-consuming and prone to network issues.
+So, if you wish to skip this step, you can do so by adding the following arg:
Review Comment:
Nit: I think it's necessary to emphasize that
`--skip-integrate-connector-docs` option should better be picked only if the
connector docs have been synced before.
--
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]
