Update group page to include link to utils check function #816
Annotations
10 errors
Run doc-validator tool:
docs/sources/k6/next/javascript-api/jslib/aws/LambdaClient/invoke.md#L8
[doc-validator] reported by reviewdog 🐶
The first heading 'LambdaClient.invoke(name, payload, [options])' doesn't match the title 'invoke'.
Decide which of the first heading or title is most applicable and change the other to match, or update them both.
Raw Output:
{"message":"The first heading 'LambdaClient.invoke(name, payload, [options])' doesn't match the title 'invoke'.\nDecide which of the first heading or title is most applicable and change the other to match, or update them both.","location":{"path":"docs/sources/k6/next/javascript-api/jslib/aws/LambdaClient/invoke.md","range":{"start":{"line":8,"column":3},"end":{"line":8,"column":3}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"h1-does-not-match-title"}}
|
Run doc-validator tool:
docs/sources/k6/next/javascript-api/k6-browser/_index.md#L7
[doc-validator] reported by reviewdog 🐶
The first heading 'browser' doesn't match the title 'k6/browser'.
Decide which of the first heading or title is most applicable and change the other to match, or update them both.
Raw Output:
{"message":"The first heading 'browser' doesn't match the title 'k6/browser'.\nDecide which of the first heading or title is most applicable and change the other to match, or update them both.","location":{"path":"docs/sources/k6/next/javascript-api/k6-browser/_index.md","range":{"start":{"line":7,"column":3},"end":{"line":7,"column":3}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"h1-does-not-match-title"}}
|
Run doc-validator tool:
docs/sources/k6/next/javascript-api/k6-browser/response/body.md#L6
[doc-validator] reported by reviewdog 🐶
The first heading 'allHeaders()' doesn't match the title 'body()'.
Decide which of the first heading or title is most applicable and change the other to match, or update them both.
Raw Output:
{"message":"The first heading 'allHeaders()' doesn't match the title 'body()'.\nDecide which of the first heading or title is most applicable and change the other to match, or update them both.","location":{"path":"docs/sources/k6/next/javascript-api/k6-browser/response/body.md","range":{"start":{"line":6,"column":3},"end":{"line":6,"column":3}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"h1-does-not-match-title"}}
|
Run doc-validator tool:
docs/sources/k6/next/javascript-api/k6-experimental/redis/redis-options.md#L7
[doc-validator] reported by reviewdog 🐶
The first heading 'Redis options' doesn't match the title 'Options'.
Decide which of the first heading or title is most applicable and change the other to match, or update them both.
Raw Output:
{"message":"The first heading 'Redis options' doesn't match the title 'Options'.\nDecide which of the first heading or title is most applicable and change the other to match, or update them both.","location":{"path":"docs/sources/k6/next/javascript-api/k6-experimental/redis/redis-options.md","range":{"start":{"line":7,"column":3},"end":{"line":7,"column":3}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"h1-does-not-match-title"}}
|
Run doc-validator tool:
docs/sources/k6/next/release-notes/v0.47.0.md#L1
[doc-validator] reported by reviewdog 🐶
The canonical 'https://github.com/grafana/k6/blob/master/release%20notes/v0.47.0.md' in the front matter doesn't match the source file pretty URL path '/docs/k6/next/release-notes/v0.47.0/'.
Update the canonical URL to match the pretty URL for the source path.
To determine the pretty URL for the source path:
1. Start with the root documentation URL.
For the Grafana project this would be `https://grafana.com/docs/grafana/latest/`.
2. Append the source path, ignoring the `docs/sources/` directory.
For the path `docs/sources/administration/_index.md`, append the path `administration/_index.md`.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/_index.md`.
For the path `docs/sources/administration/users.md`, append the path `administration/users.md`.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users.md`.
3. Remove any `index.md`, `_index.md`, or `.md` from the URL.
For the path `docs/sources/administration/_index.md`, remove `_index.md` from the canonical URL.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/`
For the path `docs/sources/administration/users.md`, remove `.md` from the canonical URL.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users`
4. Append a trailing slash if there isn't one already.
For the path `docs/sources/administration/_index.md`, do nothing.
The canonical URL remains `https://grafana.com/docs/grafana/latest/administration/`
For the path `docs/sources/administration/users.md`, add a trailing slash.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users/`
Raw Output:
{"message":"The canonical 'https://github.com/grafana/k6/blob/master/release%20notes/v0.47.0.md' in the front matter doesn't match the source file pretty URL path '/docs/k6/next/release-notes/v0.47.0/'.\nUpdate the canonical URL to match the pretty URL for the source path.\n\nTo determine the pretty URL for the source path:\n\n1. Start with the root documentation URL.\n For the Grafana project this would be `https://grafana.com/docs/grafana/latest/`.\n\n2. Append the source path, ignoring the `docs/sources/` directory.\n For the path `docs/sources/administration/_index.md`, append the path `administration/_index.md`.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/_index.md`.\n\n For the path `docs/sources/administration/users.md`, append the path `administration/users.md`.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users.md`.\n\n3. Remove any `index.md`, `_index.md`, or `.md` from the URL.\n For the path `docs/sources/administration/_index.md`, remove `_index.md` from the canonical URL.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/`\n\n For the path `docs/sources/administration/users.md`, remove `.md` from the canonical URL.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users`\n\n4. Append a trailing slash if there isn't one already.\n For the path `docs/sources/administration/_index.md`, do nothing.\n The canonical URL remains `https://grafana.com/docs/grafana/latest/administration/`\n\n For the path `docs/sources/administration/users.md`, add a trailing slash.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users/`","location":{"path":"docs/sources/k6/next/release-notes/v0.47.0.md","range":{"start":{},"end":{}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"canonical-does-not-match-pretty-URL"}}
|
Run doc-validator tool:
docs/sources/k6/next/release-notes/v0.48.0.md#L1
[doc-validator] reported by reviewdog 🐶
The canonical 'https://github.com/grafana/k6/blob/master/release%20notes/v0.48.0.md' in the front matter doesn't match the source file pretty URL path '/docs/k6/next/release-notes/v0.48.0/'.
Update the canonical URL to match the pretty URL for the source path.
To determine the pretty URL for the source path:
1. Start with the root documentation URL.
For the Grafana project this would be `https://grafana.com/docs/grafana/latest/`.
2. Append the source path, ignoring the `docs/sources/` directory.
For the path `docs/sources/administration/_index.md`, append the path `administration/_index.md`.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/_index.md`.
For the path `docs/sources/administration/users.md`, append the path `administration/users.md`.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users.md`.
3. Remove any `index.md`, `_index.md`, or `.md` from the URL.
For the path `docs/sources/administration/_index.md`, remove `_index.md` from the canonical URL.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/`
For the path `docs/sources/administration/users.md`, remove `.md` from the canonical URL.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users`
4. Append a trailing slash if there isn't one already.
For the path `docs/sources/administration/_index.md`, do nothing.
The canonical URL remains `https://grafana.com/docs/grafana/latest/administration/`
For the path `docs/sources/administration/users.md`, add a trailing slash.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users/`
Raw Output:
{"message":"The canonical 'https://github.com/grafana/k6/blob/master/release%20notes/v0.48.0.md' in the front matter doesn't match the source file pretty URL path '/docs/k6/next/release-notes/v0.48.0/'.\nUpdate the canonical URL to match the pretty URL for the source path.\n\nTo determine the pretty URL for the source path:\n\n1. Start with the root documentation URL.\n For the Grafana project this would be `https://grafana.com/docs/grafana/latest/`.\n\n2. Append the source path, ignoring the `docs/sources/` directory.\n For the path `docs/sources/administration/_index.md`, append the path `administration/_index.md`.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/_index.md`.\n\n For the path `docs/sources/administration/users.md`, append the path `administration/users.md`.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users.md`.\n\n3. Remove any `index.md`, `_index.md`, or `.md` from the URL.\n For the path `docs/sources/administration/_index.md`, remove `_index.md` from the canonical URL.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/`\n\n For the path `docs/sources/administration/users.md`, remove `.md` from the canonical URL.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users`\n\n4. Append a trailing slash if there isn't one already.\n For the path `docs/sources/administration/_index.md`, do nothing.\n The canonical URL remains `https://grafana.com/docs/grafana/latest/administration/`\n\n For the path `docs/sources/administration/users.md`, add a trailing slash.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users/`","location":{"path":"docs/sources/k6/next/release-notes/v0.48.0.md","range":{"start":{},"end":{}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"canonical-does-not-match-pretty-URL"}}
|
Run doc-validator tool:
docs/sources/k6/next/release-notes/v0.49.0.md#L1
[doc-validator] reported by reviewdog 🐶
The canonical 'https://github.com/grafana/k6/blob/master/release%20notes/v0.49.0.md' in the front matter doesn't match the source file pretty URL path '/docs/k6/next/release-notes/v0.49.0/'.
Update the canonical URL to match the pretty URL for the source path.
To determine the pretty URL for the source path:
1. Start with the root documentation URL.
For the Grafana project this would be `https://grafana.com/docs/grafana/latest/`.
2. Append the source path, ignoring the `docs/sources/` directory.
For the path `docs/sources/administration/_index.md`, append the path `administration/_index.md`.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/_index.md`.
For the path `docs/sources/administration/users.md`, append the path `administration/users.md`.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users.md`.
3. Remove any `index.md`, `_index.md`, or `.md` from the URL.
For the path `docs/sources/administration/_index.md`, remove `_index.md` from the canonical URL.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/`
For the path `docs/sources/administration/users.md`, remove `.md` from the canonical URL.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users`
4. Append a trailing slash if there isn't one already.
For the path `docs/sources/administration/_index.md`, do nothing.
The canonical URL remains `https://grafana.com/docs/grafana/latest/administration/`
For the path `docs/sources/administration/users.md`, add a trailing slash.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users/`
Raw Output:
{"message":"The canonical 'https://github.com/grafana/k6/blob/master/release%20notes/v0.49.0.md' in the front matter doesn't match the source file pretty URL path '/docs/k6/next/release-notes/v0.49.0/'.\nUpdate the canonical URL to match the pretty URL for the source path.\n\nTo determine the pretty URL for the source path:\n\n1. Start with the root documentation URL.\n For the Grafana project this would be `https://grafana.com/docs/grafana/latest/`.\n\n2. Append the source path, ignoring the `docs/sources/` directory.\n For the path `docs/sources/administration/_index.md`, append the path `administration/_index.md`.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/_index.md`.\n\n For the path `docs/sources/administration/users.md`, append the path `administration/users.md`.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users.md`.\n\n3. Remove any `index.md`, `_index.md`, or `.md` from the URL.\n For the path `docs/sources/administration/_index.md`, remove `_index.md` from the canonical URL.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/`\n\n For the path `docs/sources/administration/users.md`, remove `.md` from the canonical URL.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users`\n\n4. Append a trailing slash if there isn't one already.\n For the path `docs/sources/administration/_index.md`, do nothing.\n The canonical URL remains `https://grafana.com/docs/grafana/latest/administration/`\n\n For the path `docs/sources/administration/users.md`, add a trailing slash.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users/`","location":{"path":"docs/sources/k6/next/release-notes/v0.49.0.md","range":{"start":{},"end":{}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"canonical-does-not-match-pretty-URL"}}
|
Run doc-validator tool:
docs/sources/k6/next/release-notes/v0.50.0.md#L1
[doc-validator] reported by reviewdog 🐶
The canonical 'https://github.com/grafana/k6/blob/master/release%20notes/v0.50.0.md' in the front matter doesn't match the source file pretty URL path '/docs/k6/next/release-notes/v0.50.0/'.
Update the canonical URL to match the pretty URL for the source path.
To determine the pretty URL for the source path:
1. Start with the root documentation URL.
For the Grafana project this would be `https://grafana.com/docs/grafana/latest/`.
2. Append the source path, ignoring the `docs/sources/` directory.
For the path `docs/sources/administration/_index.md`, append the path `administration/_index.md`.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/_index.md`.
For the path `docs/sources/administration/users.md`, append the path `administration/users.md`.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users.md`.
3. Remove any `index.md`, `_index.md`, or `.md` from the URL.
For the path `docs/sources/administration/_index.md`, remove `_index.md` from the canonical URL.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/`
For the path `docs/sources/administration/users.md`, remove `.md` from the canonical URL.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users`
4. Append a trailing slash if there isn't one already.
For the path `docs/sources/administration/_index.md`, do nothing.
The canonical URL remains `https://grafana.com/docs/grafana/latest/administration/`
For the path `docs/sources/administration/users.md`, add a trailing slash.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users/`
Raw Output:
{"message":"The canonical 'https://github.com/grafana/k6/blob/master/release%20notes/v0.50.0.md' in the front matter doesn't match the source file pretty URL path '/docs/k6/next/release-notes/v0.50.0/'.\nUpdate the canonical URL to match the pretty URL for the source path.\n\nTo determine the pretty URL for the source path:\n\n1. Start with the root documentation URL.\n For the Grafana project this would be `https://grafana.com/docs/grafana/latest/`.\n\n2. Append the source path, ignoring the `docs/sources/` directory.\n For the path `docs/sources/administration/_index.md`, append the path `administration/_index.md`.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/_index.md`.\n\n For the path `docs/sources/administration/users.md`, append the path `administration/users.md`.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users.md`.\n\n3. Remove any `index.md`, `_index.md`, or `.md` from the URL.\n For the path `docs/sources/administration/_index.md`, remove `_index.md` from the canonical URL.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/`\n\n For the path `docs/sources/administration/users.md`, remove `.md` from the canonical URL.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users`\n\n4. Append a trailing slash if there isn't one already.\n For the path `docs/sources/administration/_index.md`, do nothing.\n The canonical URL remains `https://grafana.com/docs/grafana/latest/administration/`\n\n For the path `docs/sources/administration/users.md`, add a trailing slash.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users/`","location":{"path":"docs/sources/k6/next/release-notes/v0.50.0.md","range":{"start":{},"end":{}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"canonical-does-not-match-pretty-URL"}}
|
Run doc-validator tool:
docs/sources/k6/next/release-notes/v0.51.0.md#L1
[doc-validator] reported by reviewdog 🐶
The canonical 'https://github.com/grafana/k6/blob/master/release%20notes/v0.51.0.md' in the front matter doesn't match the source file pretty URL path '/docs/k6/next/release-notes/v0.51.0/'.
Update the canonical URL to match the pretty URL for the source path.
To determine the pretty URL for the source path:
1. Start with the root documentation URL.
For the Grafana project this would be `https://grafana.com/docs/grafana/latest/`.
2. Append the source path, ignoring the `docs/sources/` directory.
For the path `docs/sources/administration/_index.md`, append the path `administration/_index.md`.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/_index.md`.
For the path `docs/sources/administration/users.md`, append the path `administration/users.md`.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users.md`.
3. Remove any `index.md`, `_index.md`, or `.md` from the URL.
For the path `docs/sources/administration/_index.md`, remove `_index.md` from the canonical URL.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/`
For the path `docs/sources/administration/users.md`, remove `.md` from the canonical URL.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users`
4. Append a trailing slash if there isn't one already.
For the path `docs/sources/administration/_index.md`, do nothing.
The canonical URL remains `https://grafana.com/docs/grafana/latest/administration/`
For the path `docs/sources/administration/users.md`, add a trailing slash.
The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users/`
Raw Output:
{"message":"The canonical 'https://github.com/grafana/k6/blob/master/release%20notes/v0.51.0.md' in the front matter doesn't match the source file pretty URL path '/docs/k6/next/release-notes/v0.51.0/'.\nUpdate the canonical URL to match the pretty URL for the source path.\n\nTo determine the pretty URL for the source path:\n\n1. Start with the root documentation URL.\n For the Grafana project this would be `https://grafana.com/docs/grafana/latest/`.\n\n2. Append the source path, ignoring the `docs/sources/` directory.\n For the path `docs/sources/administration/_index.md`, append the path `administration/_index.md`.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/_index.md`.\n\n For the path `docs/sources/administration/users.md`, append the path `administration/users.md`.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users.md`.\n\n3. Remove any `index.md`, `_index.md`, or `.md` from the URL.\n For the path `docs/sources/administration/_index.md`, remove `_index.md` from the canonical URL.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/`\n\n For the path `docs/sources/administration/users.md`, remove `.md` from the canonical URL.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users`\n\n4. Append a trailing slash if there isn't one already.\n For the path `docs/sources/administration/_index.md`, do nothing.\n The canonical URL remains `https://grafana.com/docs/grafana/latest/administration/`\n\n For the path `docs/sources/administration/users.md`, add a trailing slash.\n The canonical URL becomes `https://grafana.com/docs/grafana/latest/administration/users/`","location":{"path":"docs/sources/k6/next/release-notes/v0.51.0.md","range":{"start":{},"end":{}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"canonical-does-not-match-pretty-URL"}}
|
Run doc-validator tool
reviewdog: Too many results (annotations) in diff.
You may miss some annotations due to GitHub limitation for annotation created by logging command.
Please check GitHub Actions log console to see all results.
Limitation:
- 10 warning annotations and 10 error annotations per step
- 50 annotations per job (sum of annotations from all the steps)
- 50 annotations per run (separate from the job annotations, these annotations aren't created by users)
Source: https://github.com/orgs/community/discussions/26680#discussioncomment-3252835
|
Loading