5 Commits (89985399817dde28fe5b94de990133d904bc3e5b)

Author	SHA1	Message	Date
Jack Baldry	8391e557b1	Update doc-validator to v3.0.0 (#9666) ... ## 3.0.0 ### Added - Structured output for use with [`reviewdog`](https://github.com/reviewdog/reviewdog). You can achieve the original error output by piping the output to the following `jq` expression: `jq -r '"ERROR: \(.location.path):\(.location.range.start.line):\(.location.range.start.column): \(.message)"'`. - Suggestions for simple link fixes. In GitHub, [`reviewdog`](https://github.com/reviewdog/reviewdog) comments these suggestions for convenient replacement. - Support for anchors referring to repeated headings. In the case that a page has multiple headings that share the same text, the renderer appends a zero indexed, numbered suffix to the identifier. For example, when there are two headings that are both "Heading text", the first anchor identifier is `heading-text` and the second is `heading-text-1`. - Error when running `doc-validator` on no files. **Notes for reviewer:** This also updates the `make-docs` procedure. Please ensure you can run `make docs` from the `docs/` directory before approving and merging this PR. --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com>	3 years ago
Jack Baldry	da2c5dfc56	Skip image validation (#8425) ... Signed-off-by: Jack Baldry <jack.baldry@grafana.com>	3 years ago
Jack Baldry	de38da69bc	Update doc-validator to latest release (#8221)	3 years ago
Jack Baldry	33553c9462	Use latest release of doc-validator image (#8211) ... - Fixes regression where non-Markdown files are considered for linting. - Uses a canonical algorithm for converting headings to anchor identifiers taken from the Hugo source. Signed-off-by: Jack Baldry <jack.baldry@grafana.com>	3 years ago
Jack Baldry	3cb15d62d5	Docs: Add doc-validator tool to lint technical documentation (#6569) ... Source code: https://github.com/grafana/technical-documentation/tree/main/tools/doc-validator Signed-off-by: Jack Baldry <jack.baldry@grafana.com> **What this PR does / why we need it**: Adds a CI step for pull requests that validates links in technical documentation and performs linting of technical documentation source files. **Special notes for your reviewer**: - Lots of issues will need to be fixed before we can merge this. - The tool is still in early development so each error should be scrutinized for validity. **Checklist** - [ ] Documentation added - [na] Tests updated - [na] Is this an important fix or new feature? Add an entry in the `CHANGELOG.md`. - [na] Changes that require user attention or interaction to upgrade are documented in `docs/sources/upgrading/_index.md` Signed-off-by: Jack Baldry <jack.baldry@grafana.com>	3 years ago