Update JavaScript API to share the content of the module overview with the module page
#599
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Validate documentation | |
| on: | |
| pull_request: | |
| paths: ["docs/sources/**"] | |
| workflow_dispatch: | |
| jobs: | |
| doc-validator: | |
| runs-on: "ubuntu-latest" | |
| container: | |
| image: "grafana/doc-validator:v5.1.0" | |
| steps: | |
| - name: "Checkout code" | |
| uses: "actions/checkout@v4" | |
| - name: "Run doc-validator tool" | |
| run: > | |
| doc-validator | |
| '--skip-checks=^image.+$' | |
| docs/sources | |
| /docs/k6 | |
| | grep -v "The 'description' parameter in the front matter must be present." | |
| | reviewdog | |
| -f=rdjsonl | |
| --fail-on-error | |
| --filter-mode=nofilter | |
| --name=doc-validator | |
| --reporter=github-pr-review | |
| env: | |
| REVIEWDOG_GITHUB_API_TOKEN: "${{ secrets.GITHUB_TOKEN }}" |