5 Commits (ab6d82a33c938e1527a28a276638eb00d618bc37)

Author	SHA1	Message	Date
Jack Baldry	e8b4228f89	Update `make docs` procedure and related workflows (#71537) ... * Add myself as CODEOWNER for `make docs` procedure and related workflows Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update `make docs` procedure Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Add workflow to update `make docs` procedure Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update doc-validator workflow Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix team handle Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Clean up CODEOWNERS Signed-off-by: Jack Baldry <jack.baldry@grafana.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com>	2 years ago
Jack Baldry	a4a16b62c7	Update make-docs procedure (#70265) ... ## 4.1.0 (2023-06-16) ### Added - Mounts of `layouts` and `config` directories for the `website` project. Ensures that local changes to mounts or shortcodes are reflected in the development server. ### Fixed - Version inference for versioned docs pages. Pages in versioned projects now have the `versioned: true` front matter set to ensure that "version" in $.Page.Scratch is set on builds. ## 4.0.0 (2023-06-06) ### Removed - `doc-validator/%` target. The behavior of the target was not as described. Instead, to limit `doc-validator` to only specific files, refer to https://grafana.com/docs/writers-toolkit/writing-guide/tooling-and-workflows/validate-technical-documentation/#run-on-specific-files. ## 3.0.0 (2023-05-18) ### Fixed - Compatibility with the updated Make targets in the `website` repository. `docs` now runs this script itself, `server-docs` builds the site with the `docs` Hugo environment. Signed-off-by: Jack Baldry <jack.baldry@grafana.com>	3 years ago
Jack Baldry	6c4cf4f8b9	Enable doc-validator for alerting directories (#68964) ... * Enable doc-validator for alerting directories Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Adds missing description frontmatter * Fix some more links Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix some more links Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fixes anchors --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>	3 years ago
Jack Baldry	560f49b3dc	Enable doc-validator for specific directories (#63524) ... * Enable doc-validator for specific directories Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix one linting error to trigger CI Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update doc-validator to latest release Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update make-docs procedure Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use doc-validator version from CI in local make target Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Revert to 1.11.0 Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * adds missing descriptions * Fix titles and headings Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix link formats Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix easy to resolve anchors Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Remove broken anchor link This anchor appears to have been broken for a long time. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use doc-validator image with support for numbered anchors Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update make-docs procedure to support doc-validator 2.0.x Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix a bunch of broken anchors Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Ignore old whatsnew content Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update doc-validator to v2.0.x and use reviewdog to report errors Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * removes broken links --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Chris Moyer <chris.moyer@grafana.com>	3 years ago
Jack Baldry	43fbb9804e	Use centralized make-docs script from Writers' Toolkit (#66440) ... - 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>	3 years ago