[
https://issues.apache.org/jira/browse/FLINK-34362?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jane Chan reassigned FLINK-34362:
---------------------------------
Assignee: Yunhong Zheng
> Add argument to reuse connector docs cache in setup_docs.sh to improve build
> times
> ----------------------------------------------------------------------------------
>
> Key: FLINK-34362
> URL: https://issues.apache.org/jira/browse/FLINK-34362
> Project: Flink
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 1.19.0
> Reporter: Jane Chan
> Assignee: Yunhong Zheng
> Priority: Minor
>
> Problem:
> The current build process of Flink's documentation involves the
> `setup_docs.sh` script, which re-clones connector repositories every time the
> documentation is built. This operation is time-consuming, particularly for
> developers in regions with slower internet connections or facing network
> restrictions (like the Great Firewall in China). This results in a build
> process that can take an excessive amount of time, hindering developer
> productivity.
>
> Proposal:
> We could add a command-line argument (e.g., --use-doc-cache) to the
> `setup_docs.sh` script, which, when set, skips the cloning step if the
> connector repositories have already been cloned previously. As a result,
> developers can opt to use the cache when they do not require the latest
> versions of the connectors' documentation. This change will reduce build
> times significantly and improve the developer experience for those working on
> the documentation.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
