Cleanup CI for documentation

glrf commented 1 year ago

Summary

This PR cleans up the CI for documentation changes.

Tests (including e2e tests) and code linter are not run in CI if the PR only changes documentation
Code Linting does not generate documentation anymore
Remove Make targets:
- make docs-<html/pdf/...>: Was broken since v1.2.0 and not used as final documentation webpage is generated separately
- make docs-syntax: Was broken since v1.2.0
- make docs-htmltest: Was broken since v1.2.0
- Meta tags to generate downloadable docs
Removed any dependency other than podman/docker for working with documentation
- Auto detects if using docker or podman
- Auto detects if go is present on machine. Otherwise uses golang container for auto-generating documentation
Add documentation linting step to CI that runs vale (only if documentation changes)

See https://github.com/k8up-io/k8up/pull/870 for a PR that only touches documentation (and fixes vale linting issues)

[x] Categorize the PR by setting a good title and adding one of the labels: bug, enhancement, documentation, change, breaking, dependency as they show up in the changelog
[x] I have not made any changes in the charts/ directory.

glrf commented 1 year ago

E2E test are flaky, but as I didn't change anything related and I'll need to merge https://github.com/k8up-io/k8up/pull/870 anyway, I'll ignore

glrf commented 1 year ago

E2E test is flaking again, but as we did not change anything that can effect it, I'm merging.