Link checking fails on external links

[bmorelli25]

Summary

The build is trying to link check links that don't exist. These links are failing. You can find examples in https://github.com/elastic/observability-docs.md/actions/runs/12758638542/job/35561040730. A couple of examples are below:

Error: `kibana-navigation-search` does not exist in .
    ┌─[/github/workspace/docs/configure-data-sources.md]
    │
 12 │ 1. Find `Logs / Settings` in the [global search field]({{kibana-ref}}/introduction.html#kibana-navigation-search).
    ·  ────────────────────────────────────────────────────────

Error: `privileges-list-cluster` does not exist in .
    ┌─[/github/workspace/docs/synthetics-role-setup.md]
    │
 36 │ | [Cluster]({{ref}}/security-privileges.html#privileges-list-cluster) | `read_pipeline` | Gives the user read-only access to the ingest pipline. |
    ·  ────────────────────────────────────────────────────────

Expected behavior

We can't let these failures prevent the build from succeeding. These links will not work until we move content around and replace this link syntax with the new link syntax/system that Jan is building.

[reakaleek]

The cross-link syntax is already accepted by docs-builder.

Hence, if you add a link like this:

[kibana introduction](kibana://introduction.md)

or

[kibana introduction][kibana-intro]

[kibana-intro]: kibana://introduction.md

Also see #168

Then, the build will succeed.

However, we are not yet resolving the link as it might still depend on the assembler on how it's resolved.

[reakaleek]

@Mpdreamz

I see two options here:

• use the new cross-link syntax already
• ignore links that contain {{ or }} from the check.

WDYT?

[Mpdreamz]

These are real failures that need addressing but we can make links with {{ or }} in them warnings temporarily.

That way they still get flagged and folks can start addressing them.

e.g ({{ref}}/security-privileges.html#privileges-list-cluster) is a local link that should be written as /security-privileges.md#priveleges-list-cluster.

({{kibana-ref}}/introduction.html#kibana-navigation-search) should be kibana://introduction.md#kibana-navigation-search

The first is something perhaps the migration tool can unroll automatically?

The latter maybe too but requires a more complex mapping of elastic.co urls to repository names.

[reakaleek]

Ah, I just discovered that {{kibana-ref}} and {{ref}} is defined in https://github.com/elastic/observability-docs.md/blob/main/docs/docset.yml#L494

Does this change anything? @Mpdreamz

[Mpdreamz]

No we still don't want links like these moving forward.

We don't want variables in links and these links should point to documentation files not URLs.

[reakaleek]

This will add a warning if the string contains {{ or }} #191

[reakaleek]

I this solved with #191?