Skip to content

[DOC] Doc updates for 2.2 release #179

[DOC] Doc updates for 2.2 release

[DOC] Doc updates for 2.2 release #179

Triggered via pull request August 1, 2023 02:37
Status Failure
Total duration 26s
Artifacts

doc-validator.yml

on: pull_request
doc-validator
19s
doc-validator
Fit to window
Zoom out
Zoom in

Annotations

8 errors
doc-validator: docs/sources/tempo/release-notes/v2-2.md#L32
[doc-validator] reported by reviewdog 🐶 The relref '{{< relref "../traceql/" >}}' has a trailing slash, which can break the resolution. You can reference an `index.md` file either by its path or by its containing folder without the ending `/`. You can reference an `_index.md` file only by its containing folder. Remove the trailing slash to make sure that changing the index type doesn't break the link. Raw Output: {"message":"The relref '{{< relref \"../traceql/\" >}}' has a trailing slash, which can break the resolution.\nYou can reference an `index.md` file either by its path or by its containing folder without the ending `/`.\nYou can reference an `_index.md` file only by its containing folder.\n\nRemove the trailing slash to make sure that changing the index type doesn't break the link.","location":{"path":"docs/sources/tempo/release-notes/v2-2.md","range":{"start":{"line":32,"column":41},"end":{"line":32,"column":89}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"relref-has-trailing-slash"},"suggestions":[{"range":{"start":{"line":32,"column":41},"end":{"line":32,"column":89}},"text":"[TraceQL language]({{< relref \"../traceql\" >}})"}]}
doc-validator: docs/sources/tempo/release-notes/v2-2.md#L36
[doc-validator] reported by reviewdog 🐶 The link to the project page '{{&lt; relref "../traceql#selection" >}}' is invalid. Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}} Raw Output: {"message":"The link to the project page '{{&lt; relref \"../traceql#selection\" >}}' is invalid. Links to project pages must use a Hugo relref shortcode like {{< relref \"./path/to/page\" >}}","location":{"path":"docs/sources/tempo/release-notes/v2-2.md","range":{"start":{"line":36,"column":127},"end":{"line":36,"column":184}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"project-link-invalid"},"suggestions":[{"range":{"start":{"line":36,"column":127},"end":{"line":36,"column":184}},"text":"[documentation]({{< relref \"{{&lt; relref \" >}})"}]}
doc-validator: docs/sources/tempo/release-notes/v2-2.md#L75
[doc-validator] reported by reviewdog 🐶 The link target 'https://grafana.com/docs/grafana-cloud/data-configuration/traces/metrics-summary-api/' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain. Links to grafana.com pages must be one of the following: - For linking to headings within the current page, use an anchor starting with a hash (#). For example, #heading. - For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter. Using a relative path parameter, for example, {{< relref "./path/to/page" >}} or {{ relref "../other/path" }}. Using an absolute path parameter, for example, {{< relref "/docs/grafana-cloud" >}}. - For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path. For example, /blogs/. For an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html. Raw Output: {"message":"The link target 'https://grafana.com/docs/grafana-cloud/data-configuration/traces/metrics-summary-api/' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain.\nLinks to grafana.com pages must be one of the following:\n - For linking to headings within the current page, use an anchor starting with a hash (#).\n For example, #heading.\n\n - For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter.\n Using a relative path parameter, for example, {{< relref \"./path/to/page\" >}} or {{ relref \"../other/path\" }}.\n Using an absolute path parameter, for example, {{< relref \"/docs/grafana-cloud\" >}}.\n\n - For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path.\n For example, /blogs/.\n\nFor an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html.","location":{"path":"docs/sources/tempo/release-notes/v2-2.md","range":{"start":{"line":75,"column":43},"end":{"line":75,"column":167}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"grafana-com-link-invalid"}}
doc-validator: docs/sources/tempo/release-notes/v2-2.md#L82
[doc-validator] reported by reviewdog 🐶 The link target 'https://grafana.com/docs/tempo/latest/api_docs/#search-tag-values' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain. Links to grafana.com pages must be one of the following: - For linking to headings within the current page, use an anchor starting with a hash (#). For example, #heading. - For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter. Using a relative path parameter, for example, {{< relref "./path/to/page" >}} or {{ relref "../other/path" }}. Using an absolute path parameter, for example, {{< relref "/docs/grafana-cloud" >}}. - For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path. For example, /blogs/. For an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html. Raw Output: {"message":"The link target 'https://grafana.com/docs/tempo/latest/api_docs/#search-tag-values' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain.\nLinks to grafana.com pages must be one of the following:\n - For linking to headings within the current page, use an anchor starting with a hash (#).\n For example, #heading.\n\n - For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter.\n Using a relative path parameter, for example, {{< relref \"./path/to/page\" >}} or {{ relref \"../other/path\" }}.\n Using an absolute path parameter, for example, {{< relref \"/docs/grafana-cloud\" >}}.\n\n - For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path.\n For example, /blogs/.\n\nFor an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html.","location":{"path":"docs/sources/tempo/release-notes/v2-2.md","range":{"start":{"line":82,"column":13},"end":{"line":82,"column":92}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"grafana-com-link-invalid"}}
doc-validator: docs/sources/tempo/release-notes/v2-2.md#L82
[doc-validator] reported by reviewdog 🐶 The link target 'https://grafana.com/docs/tempo/latest/api_docs/#search-tags' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain. Links to grafana.com pages must be one of the following: - For linking to headings within the current page, use an anchor starting with a hash (#). For example, #heading. - For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter. Using a relative path parameter, for example, {{< relref "./path/to/page" >}} or {{ relref "../other/path" }}. Using an absolute path parameter, for example, {{< relref "/docs/grafana-cloud" >}}. - For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path. For example, /blogs/. For an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html. Raw Output: {"message":"The link target 'https://grafana.com/docs/tempo/latest/api_docs/#search-tags' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain.\nLinks to grafana.com pages must be one of the following:\n - For linking to headings within the current page, use an anchor starting with a hash (#).\n For example, #heading.\n\n - For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter.\n Using a relative path parameter, for example, {{< relref \"./path/to/page\" >}} or {{ relref \"../other/path\" }}.\n Using an absolute path parameter, for example, {{< relref \"/docs/grafana-cloud\" >}}.\n\n - For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path.\n For example, /blogs/.\n\nFor an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html.","location":{"path":"docs/sources/tempo/release-notes/v2-2.md","range":{"start":{"line":82,"column":97},"end":{"line":82,"column":169}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"grafana-com-link-invalid"}}
doc-validator: docs/sources/tempo/release-notes/v2-2.md#L86
[doc-validator] reported by reviewdog 🐶 The link to the project page '{{< relrelf "../metrics-generator/service_graphs#virtual-nodes" >}}' is invalid. Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}} Raw Output: {"message":"The link to the project page '{{< relrelf \"../metrics-generator/service_graphs#virtual-nodes\" >}}' is invalid. Links to project pages must use a Hugo relref shortcode like {{< relref \"./path/to/page\" >}}","location":{"path":"docs/sources/tempo/release-notes/v2-2.md","range":{"start":{"line":86,"column":61},"end":{"line":86,"column":145}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"project-link-invalid"},"suggestions":[{"range":{"start":{"line":86,"column":61},"end":{"line":86,"column":145}},"text":"[documentation]({{< relref \"{{< relrelf \" >}})"}]}
doc-validator: docs/sources/tempo/release-notes/v2-2.md#L96
[doc-validator] reported by reviewdog 🐶 The link target 'https://grafana.com/docs/tempo/next/configuration/parquet/#choose-a-different-block-format' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain. Links to grafana.com pages must be one of the following: - For linking to headings within the current page, use an anchor starting with a hash (#). For example, #heading. - For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter. Using a relative path parameter, for example, {{< relref "./path/to/page" >}} or {{ relref "../other/path" }}. Using an absolute path parameter, for example, {{< relref "/docs/grafana-cloud" >}}. - For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path. For example, /blogs/. For an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html. Raw Output: {"message":"The link target 'https://grafana.com/docs/tempo/next/configuration/parquet/#choose-a-different-block-format' is invalid. Links to grafana.com pages must not include the hostname so that they can be resolved regardless of domain.\nLinks to grafana.com pages must be one of the following:\n - For linking to headings within the current page, use an anchor starting with a hash (#).\n For example, #heading.\n\n - For linking to other pages in the current documentation set, use a Hugo relref with either an absolute path or relative path parameter.\n Using a relative path parameter, for example, {{< relref \"./path/to/page\" >}} or {{ relref \"../other/path\" }}.\n Using an absolute path parameter, for example, {{< relref \"/docs/grafana-cloud\" >}}.\n\n - For linking to any other page in the https://grafana.com site, use a partial URI consisting of an absolute path.\n For example, /blogs/.\n\nFor an explanation of partial URIs, refer to https://www.w3.org/Addressing/URL/4_3_Partial.html.","location":{"path":"docs/sources/tempo/release-notes/v2-2.md","range":{"start":{"line":96,"column":157},"end":{"line":96,"column":287}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"grafana-com-link-invalid"}}
doc-validator
Process completed with exit code 1.