This repository has been archived by the owner on Jun 23, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Ignore
docs/pages/includes
files when linting (gravitational#192)
Closes gravitational#191 The `markdown-lint` script includes all files in `docs/pages/includes`. The script also processes partial inclusion expressions within docs pages, then lints those pages. This means that partials are linted at least twice: once on their own and for every time they are included in a docs page. The first lint pass for each partial usually works as expected. However, there is an issue if a partial includes a default parameter value (gravitational#171), like this: ``` {{ var="default value" }} Here is a variable with a {{ var }}. ``` When a page includes this partial, the docs engine removes the first line before inserting the resolved text. As a result, partials with default parameters render as expected and pass the linter within their including pages. But when we run the `markdown-lint` script, and the linter checks the partial on its own, the first line remains in the partial. This causes the linter to return an error. This change edits the `markdown-lint` script to ignore files within `docs/pages/includes`. This will allow us to use partials with default parameter values without them breaking CI.
- Loading branch information