Skip to content

[DOC] Update instrumentation doc to focus on OTel #503

[DOC] Update instrumentation doc to focus on OTel

[DOC] Update instrumentation doc to focus on OTel #503

Triggered via pull request November 1, 2023 02:16
Status Failure
Total duration 25s
Artifacts

doc-validator.yml

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

Annotations

3 errors
doc-validator: docs/sources/tempo/getting-started/instrumentation.md#L30
[doc-validator] reported by reviewdog 🐶 The link target 'https://grafana.com/docs/opentelemetry/' 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/opentelemetry/' 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/getting-started/instrumentation.md","range":{"start":{"line":30,"column":40},"end":{"line":30,"column":96}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"grafana-com-link-invalid"}}
doc-validator: docs/sources/tempo/getting-started/instrumentation.md#L51
[doc-validator] reported by reviewdog 🐶 The link to the project page 'h/docs/opentelemetry' 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 'h/docs/opentelemetry' is invalid. Links to project pages must use a Hugo relref shortcode like {{< relref \"./path/to/page\" >}}","location":{"path":"docs/sources/tempo/getting-started/instrumentation.md","range":{"start":{"line":51,"column":3},"end":{"line":51,"column":65}}},"severity":1,"source":{"name":"doc-validator"},"code":{"value":"project-link-invalid"},"suggestions":[{"range":{"start":{"line":51,"column":3},"end":{"line":51,"column":65}},"text":"[OpenTelemetry documentation at Grafana]({{< relref \"h/docs/opentelemetry\" >}})"}]}
doc-validator
Process completed with exit code 1.