Description

This PR proposes the use of mdox for formatting docs, both remote and local link checking, and for generating markdown code blocks within them.

• Removes previous docs link check CI and replaces it with mdox which would fail on broken links or incorrect markdown formatting. Also, mdox can be run locally and shows diffs so commiter can check beforehand.
• Removes embedmd and replaces it with mdox-exec code block directives which are much more customizable, as they use linux command outputs for formatting code blocks, for e.g yaml mdox-exec="cat example/storage/storageclass.yaml".
• Adds make docs and make check-docs for running mdox fmt and mdox fmt --check

This check currently skips all generated docs, as specified in cmd/po-docgen.

Doc transforming can be added later!

Note: Would need feedback on how Makefile and CI use mdox and if it can be better! 🙂

cc: @bwplotka

Type of change

What type of changes does your code introduce to the Prometheus operator? Put an x in the box that apply.

• CHANGE (fix or feature that would cause existing functionality to not work as expected)
• FEATURE (non-breaking change which adds functionality)
• BUGFIX (non-breaking change which fixes an issue)
• ENHANCEMENT (non-breaking change which improves existing functionality)
• NONE (if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)

Changelog entry

Add mdox to CI for easier formatting, link checking, and generation of markdown code blocks in Documentation.