mirror of
https://github.com/hanzoai/traces.git
synced 2026-10-30 18:20:41 +00:00
Jack BaldryGitHubKim NylanderKim Nylandergithub-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>* Use centralized make-docs script from Writers' Toolkit - 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. This PR incorporates some of the improvements from https://github.com/grafana/tempo/pull/2299 without introducing significant CI changes. Signed-off-by: Jack Baldry <[email protected]> * Update make-docs procedure Signed-off-by: Jack Baldry <[email protected]> * Add doc-validator workflow Signed-off-by: Jack Baldry <[email protected]> * Fix docs source directory Signed-off-by: Jack Baldry <[email protected]> * Update to latest release and skip image validation Signed-off-by: Jack Baldry <[email protected]> * Update doc-validator version https://github.com/grafana/technical-documentation/blob/main/tools/cmd/doc-validator/CHANGELOG.md Signed-off-by: Jack Baldry <[email protected]> * Update workflow for new docs directory structure Signed-off-by: Jack Baldry <[email protected]> * Fix one link Signed-off-by: Jack Baldry <[email protected]> * Update make-docs procedure and doc-validator workflow Signed-off-by: Jack Baldry <[email protected]> * Fix doc-validator linting errors Signed-off-by: Jack Baldry <[email protected]> * Also build with helm-charts/tempo-distributed docs Signed-off-by: Jack Baldry <[email protected]> * Fix doc-validator linting errors in helm-charts/tempo-distributed Signed-off-by: Jack Baldry <[email protected]> * Add descriptions to pages * Added descriptions to frontmatter * Fix number formatting * Fix validator errors * Fix build error * Fix validator issues * Fix broken link * Fix query syntax anchor link Signed-off-by: Jack Baldry <[email protected]> * Fix title to match first heading Signed-off-by: Jack Baldry <[email protected]> * Mount documentation so that both documentation sets can be tested together Signed-off-by: Jack Baldry <[email protected]> * Cause an error to double check CI Signed-off-by: Jack Baldry <[email protected]> * Fix pwd invocation Signed-off-by: Jack Baldry <[email protected]> * Use single step Signed-off-by: Jack Baldry <[email protected]> * Avoid symlinks since doc-validator doesn't follow them https://github.com/grafana/technical-documentation/issues/713 Signed-off-by: Jack Baldry <[email protected]> * Revert "Cause an error to double check CI" This reverts commit c23818004630b7240f50e7966fa261ea472a8543. Signed-off-by: Jack Baldry <[email protected]> * Update make-docs procedure Signed-off-by: Jack Baldry <[email protected]> * Break a relref for testing doc-validator CI Signed-off-by: Jack Baldry <[email protected]> * Update doc-validator to v3.0.0 ## 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. Signed-off-by: Jack Baldry <[email protected]> * Accept doc-validator suggestion Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --------- Signed-off-by: Jack Baldry <[email protected]> Co-authored-by: Kim Nylander <[email protected]> Co-authored-by: Kim Nylander <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
9 lines
179 B
Makefile
9 lines
179 B
Makefile
.ONESHELL:
|
|
.DELETE_ON_ERROR:
|
|
export SHELL := bash
|
|
export SHELLOPTS := pipefail:errexit
|
|
MAKEFLAGS += --warn-undefined-variables
|
|
MAKEFLAGS += --no-builtin-rule
|
|
|
|
include docs.mk
|