Validate yaml codeblocks in documentation
Problem to solve
We have many yaml examples in our documentation and we keep adding more. The yaml syntax is very picky with the spaces, and sometimes we end up with bad indentation, like https://gitlab.com/gitlab-org/gitlab-ce/issues/55089.
We need to find a way to test those examples.
Proposal
Lint all our markdown docs and check for broken yaml codeblocks. I don't know if there's an existing tool that we can use.
From a brief search, I found about https://github.com/remarkjs/remark-lint which has a plugin https://github.com/Qard/remark-lint-code that can validate only js
codeblocks for now. We might be able to add yaml.
Edited by Achilleas Pipinellis