ci: Add github workflow to validation documentation on PR

[gansheer]

Ref #6041

This is the same workflow as the one added to the apache/camel repository: apache/camel#19650

It validates that any change in the doc is valid with in syntax with using the doc local/partial build https://github.com/apache/camel-quarkus/blob/main/docs/README.adoc in 1 to 3 mn to execute.

It does not execute any advanced check like the dead links for now.

[gansheer]

The general goal is to have at least this workflow in the repository involved with the documentation site generated by camel-website repository.

Some questions:

• It there a workflow that checks that any modification in a extension documentation has been built into docs/** ?
• Would there be an point to have more complete documentation check that could be executed before or at the beginning of a release process ? (or on demand)

[jamesnetherton]

It there a workflow that checks that any modification in a extension documentation has been built into docs/**

Yes, the initial build step checks that there are no uncommitted files left dangling from generated content. And fails the build if there are.

Would there be an point to have more complete documentation check that could be executed before or at the beginning of a release process ? (or on demand)

It'd maybe be too late at that stage. Usually if we break the website we get notified pretty quickly and fix it before releases etc.

Do we know how long a full docs build (with link checks etc) would take?

[jamesnetherton]

Please add the workflow file into paths-ignore for ci-build.yaml & pr-validate.yml.

[gansheer]

Would there be an point to have more complete documentation check that could be executed before or at the beginning of a release process ? (or on demand)

It'd maybe be too late at that stage. Usually if we break the website we get notified pretty quickly and fix it before releases etc.

Do we know how long a full docs build (with link checks etc) would take?

The full docs build with a complete check would take approximatively 40min to run and would look like this:

      - name: Validate documentation
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        shell: bash
        run: |
          cd camel-website
          yarn workspaces foreach --all install
          cd ../camel-quarkus/docs
          yarn install
          ./local-build.sh full
          cd ../../camel-website
          yarn build:hugo
          yarn checks

It does not work correctly yet because I am missing some configuration and as a result the checks get too strict. Also the full build involves building the documentation from all repositories and would end up in failure with any error if any of the other repositories has its own error.
There are improvments to be made in the full build and check process I think before adding it to a sub-repo.