Grot (@grafanabot)
5ef56b2843
* 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>
(cherry picked from commit 560f49b3dc)
* Fix doc-validator linting
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
30 lines
926 B
YAML
30 lines
926 B
YAML
name: "doc-validator"
|
|
on:
|
|
pull_request:
|
|
paths: ["docs/sources/**"]
|
|
workflow_dispatch:
|
|
jobs:
|
|
doc-validator:
|
|
runs-on: "ubuntu-latest"
|
|
container:
|
|
image: "grafana/doc-validator:c2a784f"
|
|
steps:
|
|
- name: "Checkout code"
|
|
uses: "actions/checkout@v3"
|
|
- name: "Run doc-validator tool"
|
|
# Only run doc-validator on specific directories.
|
|
run: >
|
|
doc-validator
|
|
'--include=^docs/sources/(?:fundamentals|getting-started|introduction|setup-grafana|upgrade-guide|whatsnew/whats-new-in-v(?:9|10))/.+\.md$'
|
|
'--skip-checks=^image'
|
|
./docs/sources
|
|
/docs/grafana/latest
|
|
| reviewdog
|
|
'--efm=ERROR: %f:%l:%c %m'
|
|
--fail-on-error
|
|
--filter-mode=nofilter
|
|
--name=doc-validator
|
|
--reporter=github-pr-review
|
|
env:
|
|
REVIEWDOG_GITHUB_API_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
|