Add docs build (make check) to CI/GitHub Actions

[ntolia]

No description provided.

[vkamra]

We should be able to leverage what's described here and create an action that builds the docs Docker image and runs the make check command in it.

We would need make check to not run the docs image (or add a flag)

[ntolia]

See this GitHub Action for more information on how to cache the layers of the Docker build steps.

We should also switch CLI docs generation to be a part of the build step.

[ntolia]

Actually, the caching of layers might not always be optimal for a system like ours because of issues like satackey/action-docker-layer-caching#305. Having a Docker image in the repo based on the Dockerfile and package*.json files will probably be best.

[vkamra]

To clarify - what we need here is a docs image that is prebuilt that the docs build can use? There can be separate automation to autobuild the docs image.

[ntolia]

Yes, at a minimum.

[vkamra]

@meain - take a look at docs/README.md and docs/Makefile. Once you're familiar with that - this ticket is a good one to pick up to enable running make check during the CI process (perhaps create a separate job) so that any regressions in the CLI doc autogeneration or docs are caught before a PR merges.

[vkamra]

Adding some more details here. There are 2 stages in the docs build - 1) See make genclidocs - this generates Markdown docs for the CLI and places them in the docs/docs/cli directory 2) Docs are built using Docusaurus make build which include the generated CLI docs.

For CI: We want to run make check which will generate the CLI docs and then run vale lint and markdown lint on the files under docs.

For our release process: As part of #571 - we want to generate the CLI docs, build the docs and upload to a configured S3 location