Matthias Pohl created FLINK-32902:
-------------------------------------
Summary: Docs creation and checks in multiple locations
Key: FLINK-32902
URL: https://issues.apache.org/jira/browse/FLINK-32902
Project: Flink
Issue Type: Improvement
Components: Documentation, Test Infrastructure
Affects Versions: 1.17.1, 1.16.2, 1.18.0
Reporter: Matthias Pohl
Currently, Flink has two CI pipeline configs dealing with documentation
([tools/ci/compile.sh:83ff|https://github.com/apache/flink/blob/28aaa4b80c571fe497dd76f79e617c01e2a25869/tools/ci/compile.sh#L83]
that's used by Flink's Azure pipeline; the docs are generated in a separate
step in
[azure-pipelines.yml:89|https://github.com/apache/flink/blob/29f009b7e8c714cd5af0626e9725eb8538a4bd0f/azure-pipelines.yml#L89];
there's a Github Actions workflow that runs the generation and verification as
well using a separate script in
[.github/workflows/docs.yml:51|https://github.com/apache/flink/blob/fbb215e57919ad05f4c48b4ef79ee2f808f62ac8/.github/workflows/docs.yml#L51]).
This leads to duplicate code for documentation generation and verification.
This is redundant code which we could unify: Both pipelines should ideally rely
on the same script for generating and verifying the documentation.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
