Commit Graph

25 Commits

Author SHA1 Message Date
github-actions[bot]
3141c39d1f
Update make docs procedure (#92340)
Co-authored-by: grafanabot <bot@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-08-27 08:53:39 +01:00
github-actions[bot]
37a58d15cf
Update make docs procedure (#89933)
Co-authored-by: grafanabot <bot@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2024-07-04 15:40:43 +01:00
github-actions[bot]
d8b662e8d5
Update make docs procedure (#88404)
Co-authored-by: grafanabot <bot@grafana.com>
2024-05-29 08:12:13 +00:00
github-actions[bot]
c46c0c9eb9
Update make docs procedure (#87950)
Co-authored-by: grafanabot <bot@grafana.com>
2024-05-16 12:00:32 +01:00
github-actions[bot]
3d55602fde
Update make docs procedure (#86746)
Co-authored-by: grafanabot <bot@grafana.com>
2024-04-23 12:52:16 +01:00
github-actions[bot]
2a78ffdb75
Update make docs procedure (#83658)
Co-authored-by: grafanabot <bot@grafana.com>
2024-02-29 11:49:05 +00:00
github-actions[bot]
d541416615
Update make docs procedure (#83045)
Co-authored-by: grafanabot <bot@grafana.com>
2024-02-19 13:16:52 +02:00
github-actions[bot]
8a90c0f868
Update make docs procedure (#82342)
Co-authored-by: grafanabot <bot@grafana.com>
2024-02-13 09:45:15 +00:00
github-actions[bot]
e9dab611fe
Update make docs procedure (#82223)
Co-authored-by: grafanabot <bot@grafana.com>
2024-02-09 10:01:47 +00:00
github-actions[bot]
6fd8898cde
Update make docs procedure (#81170)
Co-authored-by: grafanabot <bot@grafana.com>
2024-01-24 16:03:38 +00:00
github-actions[bot]
ed196e67a8
Update make docs procedure (#80855)
Co-authored-by: grafanabot <bot@grafana.com>
2024-01-19 09:33:48 +00:00
github-actions[bot]
12b624313c
Update make docs procedure (#78877)
Co-authored-by: grafanabot <bot@grafana.com>
2023-11-30 08:50:38 +00:00
github-actions[bot]
f9fffd3ff1
Update make docs procedure (#77536)
* Update `make docs` procedure

* Update `make docs` procedure

---------

Co-authored-by: grafanabot <bot@grafana.com>
2023-11-07 09:48:34 +00:00
github-actions[bot]
fb0ac351bc
Update make docs procedure (#76096)
* Update `make docs` procedure

* Do not run workflow on forks

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Add labels

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

---------

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: grafanabot <bot@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
2023-10-06 09:47:55 +01:00
github-actions[bot]
e63f764b83
Update make docs procedure (#74976)
Co-authored-by: grafanabot <bot@grafana.com>
2023-09-18 10:49:39 +01:00
github-actions[bot]
790b168c85
Update make docs procedure (#74306)
Co-authored-by: grafanabot <bot@grafana.com>
2023-09-04 13:27:06 +01:00
github-actions[bot]
485f07cb7d
Update make docs procedure (#74152)
Co-authored-by: grafanabot <bot@grafana.com>
2023-08-31 09:57:01 +01:00
github-actions[bot]
88d3f27b6b
Update make docs procedure (#73540)
Co-authored-by: grafanabot <bot@grafana.com>
2023-08-21 08:56:54 +01:00
github-actions[bot]
355917e755
Update make docs procedure (#73359)
Co-authored-by: grafanabot <bot@grafana.com>
2023-08-17 13:12:28 +01:00
github-actions[bot]
719f6bc520
Update make docs procedure (#72180)
Co-authored-by: grafanabot <bot@grafana.com>
2023-07-24 09:19:37 +01:00
github-actions[bot]
ca6f616bf3
Update make docs procedure (#71810)
Co-authored-by: grafanabot <bot@grafana.com>
2023-07-18 09:52:11 +01:00
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>
2023-07-13 18:24:23 +01:00
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>
2023-06-16 18:45:44 +01:00
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>
2023-05-18 15:50:20 +01:00
Jack Baldry
3c655821e8
Update make-docs script (#66841)
Update centralized make-docs procedure

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2023-04-24 16:23:33 +01:00