Skip to content

Markdown linting in the GitLab Web IDE

The CI/CD pipeline job docs-review-lint is currently always failing because linting is checked (via markdownlint-cli2) but not enforced.

Since most contributors here use the GitLab Web IDE for adding content to the documentation, we should enable extensions in the IDE's extension marketplace and have everyone use something like "markdownlint" from David Anson to automatically format the .md files before any commit.

Doing so will clear up the diffs so that only content changes are highlighted, not formatting changes. This contributes to making merge request reviews easier, especially if we envision accepting contributions from the community.

@harveywilliam.bowen : can extensions be enabled in our GitLab instance?

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information