Weaver should resolve full URL

[lmolkova]

We use absolute paths in semconv, e.g. docs/database/database-spans.md#sanitization-of-dbquerytext, but it's not quite useful outside of semconv repo. We should resolve full url - https://github.com/open-telemetry/semantic-conventions/blob/v1.34.0/docs/database/database-spans.md#sanitization-of-dbquerytext

Originally posted by @trask in open-telemetry/semantic-conventions-java#217 (comment)

[smith]

Looking at the weaver markdown parsing, this does not seems straightforward. If you were to do it, it would look something like:

• Define a base URL
• For each link in check if it's relative
• If so, prepend the base URL

I don't know if there's a concept of some kind of filter pipeline with the markdown parsing that would make this easy to do.

Would another solution be to not allow relative URLs in YAML values in the semconv repo?

The URL itself (/docs/database/...) is already making assumptions about the result of a transformation that may or may not happen.

If anybody has tips on working with Weaver's Markdown parser I'd be happy to dig some more in to it.

[jsuereth]

Strawman:

Add a doc_base_url field to the Manifest https://github.com/open-telemetry/weaver/blob/main/crates/weaver_semconv/src/manifest.rs#L24 - when weaver resolves YAML and detects a relative URL path, it can use the doc-base-url for that registry via manifest to expand into a full URL.

This should assume markdown structure for brief/note. We can then use markdown parsing to understand where links are and relative.

[jsuereth]

New proposal -

We should provide a JINJA filter function that can take in Markdown, parse it, and modify the URLs in links found within it to be absolute to some base path.

Something like:

{{ myfield_markdown | mk_md_links_absolute("/my/absolute/path") | ...next..filter }}