Pepe Cano
deec5361b7
* Alerting docs: update the Terraform Provision guide (#83773) * Alerting docs: update the Terraform Provision guide * Fix incorrect links * Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> * Update docs/sources/alerting/set-up/provision-alerting-resources/terraform-provisioning/index.md Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> --------- Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com> (cherry picked from commit111df1bba0) * Fix `doc-validator` issue with relative link * Use patch fixed version of doc-validator that better supports docs/reference destinations Signed-off-by: Jack Baldry <jack.baldry@grafana.com> --------- (cherry picked from commiteb25b669c6) Signed-off-by: Jack Baldry <jack.baldry@grafana.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
30 lines
961 B
YAML
30 lines
961 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:v4.1.1"
|
|
steps:
|
|
- name: "Checkout code"
|
|
uses: "actions/checkout@v4"
|
|
- name: "Run doc-validator tool"
|
|
# Only run doc-validator on specific directories.
|
|
run: >
|
|
doc-validator
|
|
'--include=^docs/sources/(?:alerting|fundamentals|getting-started|introduction|setup-grafana|upgrade-guide|whatsnew/whats-new-in-v(?:9|10))/.+\.md$'
|
|
'--skip-checks=^(?:image.+|canonical-does-not-match-pretty-URL)$'
|
|
./docs/sources
|
|
/docs/grafana/latest
|
|
| reviewdog
|
|
-f=rdjsonl
|
|
--fail-on-error
|
|
--filter-mode=nofilter
|
|
--name=doc-validator
|
|
--reporter=github-pr-review
|
|
env:
|
|
REVIEWDOG_GITHUB_API_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
|