6 Commits (34f5ae3cd875ab599e93e657ccfbfb5f7cdcb22e)

Author	SHA1	Message	Date
Jack Baldry	49d6d7942c	chore: Clean up docs Make variables (#18522) ... Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: J Stickler <julie.stickler@grafana.com>	6 months ago
Derek Cadzow	25785e03d5	Deleting old and irrelevant information (#11929)	2 years ago
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
Trevor Whitney	1283c42a80	Bring back centralized docs toolkit (undo revert in #9146) (#9147) ... **What this PR does / why we need it**: This reverts the revert in https://github.com/grafana/loki/pull/9146 with a slightly less "nuclear" solution. I think the problem was that CI was pulling `docs.mk` from `main`, and it was creating a diff between the version we had checked in. I changed `docs.mk` to point to a specific sha, which should prevent this in the future. I also opened a [PR](https://github.com/grafana/writers-toolkit/pull/228) against the writers-toolkit.	3 years ago
Callum Styan	220cbdd4f1	Revert "Use centralized make-docs script from Writers' Toolkit (#9126)" (#9146) ... This reverts commit df1b34898b. Sorry @jdbaldry but something in your PR made the helm-docs check fail, and only fail in CI, I tried a few things to figure out what was happening locally but the same make target always passed locally. cc @trevorwhitney	3 years ago
Jack Baldry	df1b34898b	Use centralized make-docs script from Writers' Toolkit (#9126) ... - Adds ability to build multiple projects simultaneously using, for example, `make docs PROJECTS='grafana grafana-cloud'`. - Adds `make doc-validator` which runs [`doc-validator`](https://github.com/grafana/technical-documentation/tree/main/tools/cmd/doc-validator) on all documentation. Using a centralized script will help ensure consistency in workflow across all projects. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Signed-off-by: Jack Baldry <jack.baldry@grafana.com>	3 years ago