Skip to content

Move documentation linting to Makefile

Pedro Pombeiro requested to merge docs-lint into master

What does this MR do?

This MR adds a docs-lint target to the makefile and updates the CI script to use it.

Note: eventually this will move to the common config repo (captured in gitlab-org/ci-cd/runner-common-config#7)

Why was this MR needed?

I had some failures on an MR that updated docs which only showed up on CI. By having a Makefile target that exposes the same scripts, we can avoid committing code before checking if it's OK, as well as informing devs where to install tools from if they're not available on the machine.

Are there points in the code the reviewer needs to double check?

Does this MR meet the acceptance criteria?

  • Documentation created/updated
  • Added tests for this feature/bug
  • In case of conflicts with master - branch was rebased

What are the relevant issue numbers?

Edited by 🤖 GitLab Bot 🤖

Merge request reports