Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-32902

Docs creation and checks in multiple locations

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Major
    • Resolution: Unresolved
    • 1.16.2, 1.18.0, 1.17.1
    • None
    • Documentation, Test Infrastructure

    Description

      Currently, Flink has two CI pipeline configs dealing with documentation (tools/ci/compile.sh:83ff that's used by Flink's Azure pipeline; the docs are generated in a separate step in azure-pipelines.yml:89; there's a Github Actions workflow that runs the generation and verification as well using a separate script in .github/workflows/docs.yml:51). 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.

      Attachments

        Issue Links

          Discovered while testing

          Improvement - An improvement or enhancement to an existing feature or task. FLINK-30923 Provide single script for installing Hugo

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          is caused by

          Technical Debt - FLINK-26658 Migrate documentation build to Github Actions

          • Major - Major loss of function.
          • Closed

          Activity

            People

              Unassigned Unassigned
              mapohl Matthias Pohl
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated: